Create an entitlement assignment

post

/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Criteria
Type: array
Title: Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type: array
Title: Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : subscriptionEntitlementAssignments-item-response
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Criteria
Type: array
Title: Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-item-response
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type: array
Title: Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to create a subscription entitlement assignment by submitting a POST request on the REST resource.

cURL Command

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionEntitlementAssignments  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Request Body

The following shows the contents of the request body in JSON format.
{
    "OrganizationCode": "V1",
    "InventoryItemName": "QP_Item3",
    "EntitlementPlanNumber": "CDRM_1",
    "AssignmentPrecedence": 1001,
    "assignmentCriteria": [
        {
            "BalanceCriteriaDescription": "Inline plan assignment criteria",
            "subscriptionBalancePredicates": [
                {
                    "BalanceObjectName": "Subscription",
                    "BalanceAttributeName": "PONumber",
                    "BalancePredicateOperator": "ORA_OSS_EQUALS",
                    "BalancePredicateCharacterValue": "PO123",
                    "BalancePredicateSequence": 1
                }
            ]
        }
    ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "EntitlementAssignmentId": 300100570207771,
    "EntitlementAssignmentNumber": "CDRM_7004",
    "OrganizationCode": "V1",
    "OrganizationId": 204,
    "InventoryItemName": "QP_Item3",
    "InventoryItemId": 300100012368232,
    "EntitlementPlanNumber": "CDRM_1",
    "EntitlementPlanId": 300100570153904,
    "EntitlementPlanName": "Platinum Plan",
    "AssignmentPrecedence": 1001,
    "StartDateActive": "2023-03-01",
    "EndDateActive": null,
    "AssignmentStatus": "ORA_OSS_DRAFT",
    "ObjectVersionNumber": 1,
    "CreatedBy": "CONMGR",
    "CreationDate": "2023-03-01T15:05:58+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2023-03-01T15:05:58.901+00:00",
    "LastUpdateLogin": "F5D244E63FBF3FFBE053B4A7456445B7",
    "assignmentCriteria": [
        {
            "BalanceCriteriaId": 300100570207772,
            "BalanceCriteriaNumber": "CDRM_14004",
            "BalanceCriteriaDescription": "Inline plan assignment criteria",
            "BalanceCriteriaStatus": "ORA_OSS_DRAFT",
            "BalanceCriteriaUsage": "ORA_OSS_ENTPLAN_ASSGN_CRITERIA",
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2023-03-01T15:05:58.456+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2023-03-01T15:06:20.862+00:00",
            "LastUpdateLogin": "F5D244E63FBF3FFBE053B4A7456445B7",
            "subscriptionBalancePredicates": [
                {
                    "BalancePredicateId": 300100570207773,
                    "BalancePredicateNumber": "CDRM_14004-BAPD-14004",
                    "BalanceCriteriaId": 300100570207772,
                    "BalanceObjectName": "Subscription",
                    "BalanceObjectId": 300100570153599,
                    "BalanceAttributeName": "PONumber",
                    "BalanceAttributeId": 300100570153611,
                    "BalancePredicateOperator": "ORA_OSS_EQUALS",
                    "BalancePredicateCharacterValue": "PO123",
                    "BalancePredicateNumberValue": null,
                    "BalancePredicateDecimalValue": null,
                    "BalancePredicateDateValue": null,
                    "BalancePredicateTimeValue": null,
                    "BalancePredicateSortBy": null,
                    "BalancePredicateSequence": 1,
                    "ObjectVersionNumber": 1,
                    "CreatedBy": "CONMGR",
                    "CreationDate": "2023-03-01T15:05:58.467+00:00",
                    "LastUpdatedBy": "CONMGR",
                    "LastUpdateDate": "2023-03-01T15:06:20.884+00:00",
                    "LastUpdateLogin": "F5D244E63FBF3FFBE053B4A7456445B7",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004/child/subscriptionBalancePredicates/CDRM_14004-BAPD-14004",
                            "name": "subscriptionBalancePredicates",
                            "kind": "item",
                            "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                            }
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004/child/subscriptionBalancePredicates/CDRM_14004-BAPD-14004",
                            "name": "subscriptionBalancePredicates",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004",
                            "name": "assignmentCriteria",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004",
                    "name": "assignmentCriteria",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004",
                    "name": "assignmentCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004",
                    "name": "subscriptionEntitlementAssignments",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004/child/subscriptionBalancePredicates",
                    "name": "subscriptionBalancePredicates",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004/action/activate",
                    "name": "activate",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria/CDRM_14004/action/deActivate",
                    "name": "deActivate",
                    "kind": "other"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004",
            "name": "subscriptionEntitlementAssignments",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004",
            "name": "subscriptionEntitlementAssignments",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria",
            "name": "assignmentCriteria",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/action/activate",
            "name": "activate",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/action/deActivate",
            "name": "deActivate",
            "kind": "other"
        }
    ]
}
Back to Top