TAG LINE
SMALL TITLE

Package / Service

(API Version v4)


What can you do with PackageService?


Properties

Property Details
identity
READ-ONLY
"identity": 11
Type: Number
This is the unique numeric identifier for the PackageService
packageId
"packageId": 11
Type: Number
Unique identifier for the associated Package object.
packageName
"packageName": "Sample Name"
Type: String
The name of the object associated with the packageId property.
serviceId
"serviceId": 12
Type: Number
Unique identifier for the associated Service object.
serviceName
"serviceName": "Sample Name"
Type: String
The name of the object associated with the serviceId property.
defaultInstances
"defaultInstances": 25
Type: Number
minimumInstances
"minimumInstances": 20
Type: Number
maximumInstances
"maximumInstances": 18
Type: Number
termId
"termId": 5
Type: Number
Unique identifier for the associated Term object.
termName
"termName": "Sample Name"
Type: String
The name of the object associated with the termId property.
isUsageBucketSharePlanPackageService
"isUsageBucketSharePlanPackageService": true
Type: Boolean
usageClassDynamicId
"usageClassDynamicId": 21
Type: Number
Unique identifier for the associated UsageClassDynamic object.
usageClassDynamicName
"usageClassDynamicName": "Sample Name"
Type: String
The name of the object associated with the usageClassDynamicId property.


End Points

GETapi/v4/Package/Service/
Retrieve all of the PackageService objects.
Retrieve all of the PackageService objects.
GET api/v4/Package/Service/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "packageId": 22,
            "packageName": "Sample Text Data",
            "serviceId": 15,
            "serviceName": "Sample Text Data",
            "defaultInstances": 19,
            "minimumInstances": 21,
            "maximumInstances": 16,
            "termId": 20,
            "termName": "Sample Text Data",
            "isUsageBucketSharePlanPackageService": true,
            "usageClassDynamicId": 17,
            "usageClassDynamicName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Package/Service/Paged
Retrieve all of the PackageService objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the PackageService objects in a paged fashion.
GET api/v4/Package/Service/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageId": 25,
                "packageName": "Sample Text Data",
                "serviceId": 15,
                "serviceName": "Sample Text Data",
                "defaultInstances": 25,
                "minimumInstances": 16,
                "maximumInstances": 4,
                "termId": 16,
                "termName": "Sample Text Data",
                "isUsageBucketSharePlanPackageService": true,
                "usageClassDynamicId": 0,
                "usageClassDynamicName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Package/Service/Paged/Detail
Retrieve all of the PackageService objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the PackageService objects in a paged fashion with all object details.
GET api/v4/Package/Service/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageId": 25,
                "packageName": "Sample Text Data",
                "serviceId": 10,
                "serviceName": "Sample Text Data",
                "defaultInstances": 9,
                "minimumInstances": 3,
                "maximumInstances": 5,
                "termId": 0,
                "termName": "Sample Text Data",
                "isUsageBucketSharePlanPackageService": true,
                "usageClassDynamicId": 19,
                "usageClassDynamicName": "Sample Text Data",
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Package/Service/{id}
Retrieve an instance of the PackageService object by its ID.
{id}Unique identifier for the PackageService object.
Retrieve an instance of the PackageService object by its ID.
GET api/v4/Package/Service/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "packageId": 13,
        "packageName": "Sample Text Data",
        "serviceId": 19,
        "serviceName": "Sample Text Data",
        "defaultInstances": 1,
        "minimumInstances": 5,
        "maximumInstances": 21,
        "termId": 7,
        "termName": "Sample Text Data",
        "isUsageBucketSharePlanPackageService": true,
        "usageClassDynamicId": 16,
        "usageClassDynamicName": "Sample Text Data"
    }
}
GETapi/v4/Package/Service/{id}/Detail
Retrieve deep detail of the PackageService object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the PackageService object.
Retrieve deep detail of the PackageService object by its ID.
GET api/v4/Package/Service/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "packageId": 20,
        "packageName": "Sample Text Data",
        "serviceId": 11,
        "serviceName": "Sample Text Data",
        "defaultInstances": 24,
        "minimumInstances": 14,
        "maximumInstances": 9,
        "termId": 3,
        "termName": "Sample Text Data",
        "isUsageBucketSharePlanPackageService": true,
        "usageClassDynamicId": 22,
        "usageClassDynamicName": "Sample Text Data",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
POSTapi/v4/Package/Service/Search
Retreive a list of PackageService objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of PackageService objects based on search criteria.
POST api/v4/Package/Service/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "packageId": 20,
            "packageName": "Sample Text Data",
            "serviceId": 13,
            "serviceName": "Sample Text Data",
            "defaultInstances": 24,
            "minimumInstances": 11,
            "maximumInstances": 9,
            "termId": 17,
            "termName": "Sample Text Data",
            "isUsageBucketSharePlanPackageService": true,
            "usageClassDynamicId": 20,
            "usageClassDynamicName": "Sample Text Data"
        }
    ]
}