Jump to

• Request
• Response
• Examples

Update an entitlement assignment

patch

/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}

Request

Path Parameters

• EntitlementAssignmentNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assignmentCriteria: array Subscription Balance Condition Criteria
  Title: Subscription Balance Condition Criteria

  The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.
• AssignmentPrecedence: integer
  Title: Precedence

  The precedence of assignment of subscription entitlement assignment.
• AssignmentStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of assignment of subscription entitlement assignment.
• BusinessUnitId: integer (int64)
  The unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  The name of the business unit.
• EndDateActive: string (date)
  Title: End Date

  The end date till which assignment is active in subscription entitlement assignment.
• EntitlementPlanId: integer (int64)
  The unique entitlement plan identifier of subscription entitlement assignment.
• EntitlementPlanName: string
  Title: Entitlement Plan Name

  Maximum Length: 120

  The entitlement plan name of subscription entitlement assignment.
• EntitlementPlanNumber: string
  Title: Entitlement Plan Number

  Maximum Length: 120

  The entitlement plan number of subscription entitlement assignment.
• InventoryItemId: integer (int64)
  The inventory item identifier of subscription entitlement assignment.
• InventoryItemName: string
  Title: Product Name

  Maximum Length: 300

  The inventory item name of subscription entitlement assignment.
• OrganizationCode: string
  Title: Organization

  Maximum Length: 18

  The organization code of subscription entitlement assignment.
• OrganizationId: integer (int64)
  The organization identifier of subscription entitlement assignment.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  The unique identifier of the rate plan associated to the subscription product.
• RatePlanNumber: string
  Title: Rate Plan Number

  Maximum Length: 120

  The public unique identifier of the rate plan associated with the subscription product.
• StartDateActive: string (date)
  Title: Start Date

  The start date from which assignment is active in subscription entitlement assignment.

{
    "type":"object",
    "properties":{
        "AssignmentPrecedence":{
            "title":"Precedence",
            "type":"integer",
            "description":"The precedence of assignment of subscription entitlement assignment.",
            "nullable":true
        },
        "AssignmentStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of assignment of subscription entitlement assignment.",
            "nullable":true,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The end date till which assignment is active in subscription entitlement assignment.",
            "format":"date",
            "nullable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique entitlement plan identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "EntitlementPlanName":{
            "title":"Entitlement Plan Name",
            "maxLength":120,
            "type":"string",
            "description":"The entitlement plan name of subscription entitlement assignment.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EntitlementPlanNumber":{
            "title":"Entitlement Plan Number",
            "maxLength":120,
            "type":"string",
            "description":"The entitlement plan number of subscription entitlement assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The inventory item identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InventoryItemName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The inventory item name of subscription entitlement assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":18,
            "type":"string",
            "description":"The organization code of subscription entitlement assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The organization identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the rate plan associated to the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "InventoryItemId"
                ]
            }
        },
        "RatePlanNumber":{
            "title":"Rate Plan Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the rate plan associated with the subscription product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date from which assignment is active in subscription entitlement assignment.",
            "format":"date",
            "nullable":false
        },
        "assignmentCriteria":{
            "title":"Subscription Balance Condition Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Subscription Balance Condition Criteria

Type: array

Title: Subscription Balance Condition Criteria

The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.

Show Source

• Array of: object schema

{
    "title":"Subscription Balance Condition Criteria",
    "type":"array",
    "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
    "items":{
        "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

  The description of subscription balance criterion.
• BalanceCriteriaNumber: string
  Title: Criteria

  Maximum Length: 120

  The unique number of the subscription balance criterion.
• BalanceCriteriaStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription balance criterion.
• CriteriaPrecedence: integer
  Title: Sequence

  The order in which the criteria will be evaluated.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance criterion.
• subscriptionBalancePredicates: array Subscription Balance Condition Predicates
  Title: Subscription Balance Condition Predicates

  The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.

{
    "type":"object",
    "properties":{
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CriteriaPrecedence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order in which the criteria will be evaluated.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Condition Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-patch-request"
            }
        }
    }
}

Nested Schema : Subscription Balance Condition Predicates

Type: array

Title: Subscription Balance Condition Predicates

The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.

Show Source

• Array of: object schema

{
    "title":"Subscription Balance Condition Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• BalanceAttributeId: integer (int64)
  The unique identifier of the subscription balance attribute.
• BalanceAttributeName: string
  Title: Attribute Name

  Maximum Length: 240

  The name of the subscription balance attribute.
• BalanceCriteriaId: integer (int64)
  The balance criteria Id of subscription balance predicate.
• BalanceObjectId: integer (int64)
  The balance object identifier of subscription balance predicate.
• BalanceObjectName: string
  Title: Object Name

  Maximum Length: 120

  The balance object name of subscription balance predicate.
• BalancePredicateCharacterValue: string
  Title: Value

  Maximum Length: 600

  The balance predicate character value of subscription balance predicate.
• BalancePredicateDateValue: string (date)
  Title: Value

  The balance predicate date value of subscription balance predicate.
• BalancePredicateDecimalValue: number
  Title: Value

  The balance predicate decimal value of subscription balance predicate.
• BalancePredicateNumberValue: integer
  Title: Value

  The number value of the subscription balance predicate.
• BalancePredicateOperator: string
  Title: Operator

  Maximum Length: 30

  The operator value of the subscription balance predicate.
• BalancePredicateSequence: integer
  Title: Sequence

  The balance predicate sequence of the subscription balance predicate.
• BalancePredicateSortBy: string
  Title: Sort Order

  Maximum Length: 30

  The sort by criterion of the subscription balance predicate.
• BalancePredicateTimeValue: string (date-time)
  Title: Value

  The time value of the subscription balance predicate.
• SourceType: string
  Title: Source Type

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source type of the subscription balance predicate.

{
    "type":"object",
    "properties":{
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the subscription balance attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria Id of subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance object name of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":600,
            "type":"string",
            "description":"The balance predicate character value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":30,
            "type":"string",
            "description":"The sort by criterion of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The source type of the subscription balance predicate.",
            "nullable":true,
            "default":"ORA_OSS_USER",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• assignmentCriteria: array Subscription Balance Condition Criteria
  Title: Subscription Balance Condition Criteria

  The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.
• AssignmentPrecedence: integer
  Title: Precedence

  The precedence of assignment of subscription entitlement assignment.
• AssignmentStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of assignment of subscription entitlement assignment.
• BalanceProfileName: string
  Title: Profile Name

  Read Only: true

  Maximum Length: 120

  The name of the subscription balance profile.
• BalanceProfileNumber: string
  Title: Profile Number

  Read Only: true

  Maximum Length: 120

  The unique number of the subscription balance profile.
• BusinessUnitId: integer (int64)
  The unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  The name of the business unit.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement assignment was created.
• EndDateActive: string (date)
  Title: End Date

  The end date till which assignment is active in subscription entitlement assignment.
• EntitlementAssignmentId: integer (int64)
  The unique identifier of subscription entitlement assignment.
• EntitlementAssignmentNumber: string
  Title: Number

  Maximum Length: 120

  The number of subscription entitlement assignment.
• EntitlementPlanId: integer (int64)
  The unique entitlement plan identifier of subscription entitlement assignment.
• EntitlementPlanName: string
  Title: Entitlement Plan Name

  Maximum Length: 120

  The entitlement plan name of subscription entitlement assignment.
• EntitlementPlanNumber: string
  Title: Entitlement Plan Number

  Maximum Length: 120

  The entitlement plan number of subscription entitlement assignment.
• InventoryItemId: integer (int64)
  The inventory item identifier of subscription entitlement assignment.
• InventoryItemName: string
  Title: Product Name

  Maximum Length: 300

  The inventory item name of subscription entitlement assignment.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement assignment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription entitlement assignment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription entitlement assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Title: Organization

  Maximum Length: 18

  The organization code of subscription entitlement assignment.
• OrganizationId: integer (int64)
  The organization identifier of subscription entitlement assignment.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  The unique identifier of the rate plan associated to the subscription product.
• RatePlanNumber: string
  Title: Rate Plan Number

  Maximum Length: 120

  The public unique identifier of the rate plan associated with the subscription product.
• StartDateActive: string (date)
  Title: Start Date

  The start date from which assignment is active in subscription entitlement assignment.

{
    "type":"object",
    "properties":{
        "AssignmentPrecedence":{
            "title":"Precedence",
            "type":"integer",
            "description":"The precedence of assignment of subscription entitlement assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of assignment of subscription entitlement assignment.",
            "nullable":true,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Profile Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BalanceProfileNumber":{
            "title":"Profile Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription entitlement assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The end date till which assignment is active in subscription entitlement assignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementAssignmentNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of subscription entitlement assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique entitlement plan identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanName":{
            "title":"Entitlement Plan Name",
            "maxLength":120,
            "type":"string",
            "description":"The entitlement plan name of subscription entitlement assignment.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EntitlementPlanNumber":{
            "title":"Entitlement Plan Number",
            "maxLength":120,
            "type":"string",
            "description":"The entitlement plan number of subscription entitlement assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The inventory item identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The inventory item name of subscription entitlement assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription entitlement assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":18,
            "type":"string",
            "description":"The organization code of subscription entitlement assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The organization identifier of subscription entitlement assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the rate plan associated to the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "InventoryItemId"
                ]
            }
        },
        "RatePlanNumber":{
            "title":"Rate Plan Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the rate plan associated with the subscription product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date from which assignment is active in subscription entitlement assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "assignmentCriteria":{
            "title":"Subscription Balance Condition Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Subscription Balance Condition Criteria

Type: array

Title: Subscription Balance Condition Criteria

The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.

Show Source

• Array of: object subscriptionEntitlementAssignments-assignmentCriteria-item-response

{
    "title":"Subscription Balance Condition Criteria",
    "type":"array",
    "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
    "items":{
        "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-item-response

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

  The description of subscription balance criterion.
• BalanceCriteriaId: integer (int64)
  The unique identifier of the subscription balance criterion.
• BalanceCriteriaNumber: string
  Title: Criteria

  Maximum Length: 120

  The unique number of the subscription balance criterion.
• BalanceCriteriaStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription balance criterion.
• BalanceCriteriaUsage: string
  Title: Usage

  Maximum Length: 30

  The usage condition of subscription balance criterion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance criterion.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance criterion was created.
• CriteriaPrecedence: integer
  Title: Sequence

  The order in which the criteria will be evaluated.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance criterion was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance criterion.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance criterion.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance criterion.
• subscriptionBalancePredicates: array Subscription Balance Condition Predicates
  Title: Subscription Balance Condition Predicates

  The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.

{
    "type":"object",
    "properties":{
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The usage condition of subscription balance criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaPrecedence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order in which the criteria will be evaluated.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Condition Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription Balance Condition Predicates

Type: array

Title: Subscription Balance Condition Predicates

The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.

Show Source

• Array of: object subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response

{
    "title":"Subscription Balance Condition Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response

Type: object

Show Source

• BalanceAttributeId: integer (int64)
  The unique identifier of the subscription balance attribute.
• BalanceAttributeName: string
  Title: Attribute Name

  Maximum Length: 240

  The name of the subscription balance attribute.
• BalanceCriteriaId: integer (int64)
  The balance criteria Id of subscription balance predicate.
• BalanceObjectId: integer (int64)
  The balance object identifier of subscription balance predicate.
• BalanceObjectName: string
  Title: Object Name

  Maximum Length: 120

  The balance object name of subscription balance predicate.
• BalancePredicateCharacterValue: string
  Title: Value

  Maximum Length: 600

  The balance predicate character value of subscription balance predicate.
• BalancePredicateDateValue: string (date)
  Title: Value

  The balance predicate date value of subscription balance predicate.
• BalancePredicateDecimalValue: number
  Title: Value

  The balance predicate decimal value of subscription balance predicate.
• BalancePredicateId: integer (int64)
  The unique identifier of the subscription balance predicate.
• BalancePredicateNumber: string
  Title: Number

  Maximum Length: 120

  The unique number of the subscription balance predicate.
• BalancePredicateNumberValue: integer
  Title: Value

  The number value of the subscription balance predicate.
• BalancePredicateOperator: string
  Title: Operator

  Maximum Length: 30

  The operator value of the subscription balance predicate.
• BalancePredicateSequence: integer
  Title: Sequence

  The balance predicate sequence of the subscription balance predicate.
• BalancePredicateSortBy: string
  Title: Sort Order

  Maximum Length: 30

  The sort by criterion of the subscription balance predicate.
• BalancePredicateTimeValue: string (date-time)
  Title: Value

  The time value of the subscription balance predicate.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance predicate.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance predicate was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance predicate was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance predicate.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance predicate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the subscription balance predicate.
• SourceType: string
  Title: Source Type

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source type of the subscription balance predicate.

{
    "type":"object",
    "properties":{
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the subscription balance attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria Id of subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance object name of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":600,
            "type":"string",
            "description":"The balance predicate character value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance predicate.",
            "nullable":false,
            "x-queryable":true
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":30,
            "type":"string",
            "description":"The sort by criterion of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance predicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance predicate.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The source type of the subscription balance predicate.",
            "nullable":true,
            "default":"ORA_OSS_USER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

activate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/action/activate

Parameters:

• EntitlementAssignmentNumber: $request.path.EntitlementAssignmentNumber

The method is used to activate entitlement assignment.

assignmentCriteria

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria

Parameters:

• EntitlementAssignmentNumber: $request.path.EntitlementAssignmentNumber

The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.

deActivate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/action/deActivate

Parameters:

• EntitlementAssignmentNumber: $request.path.EntitlementAssignmentNumber

The method is used to deactivate entitlement assignment.

Back to Top

Examples

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

cURL Command

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionEntitlementAssignments/CDRM_7004  \
 -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.

{
    "AssignmentPrecedence": 1021
}

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": 1021,
    "StartDateActive": "2023-03-01",
    "EndDateActive": null,
    "AssignmentStatus": "ORA_OSS_DRAFT",
    "ObjectVersionNumber": 2,
    "CreatedBy": "CONMGR",
    "CreationDate": "2023-03-01T15:05:58+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2023-03-01T15:15:05+00:00",
    "LastUpdateLogin": "F5D244E63FDB3FFBE053B4A7456445B7",
    "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "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