Jump to

• Request
• Response

Create an entitlement plan UOM conversion

post

/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/UOMConversions

Request

Path Parameters

• EntitlementPlanNumber(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.
• Upsert-Mode: string
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the UOM conversion row is active or not.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  Indicates the balance code name of the UOM conversion.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The unique identifier of balance code identifier associated to the UOM conversion.
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of balance profile identifier associated to the UOM conversion.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code associated to the UOM conversion.
• ChargeDefinitionId: integer
  Title: Charge Definition ID

  The unique identifier of charge definition identifier associated to the UOM conversion.
• ChargeName: string
  Title: Charge

  Maximum Length: 80

  The name of the charge associated to the UOM conversion.
• ChargeUOMCode: string
  Title: Charge UOM

  Maximum Length: 3

  The code of the charge associated to the UOM conversion.
• EndDate: string (date)
  Title: End Date

  The end date till the UOM conversion row remains active.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The unique identifier of entitlement plan identifier associated to the UOM conversion.
• EntitlementPlanUOMConversionId: integer (int64)
  Title: UOM Conversion ID

  The unique identifier of entitlement plan UOM conversions.
• EntitlementPlanUOMConversionNumber: string
  Title: UOM Conversion Number

  Maximum Length: 120

  The unique number of entitlement plan UOM conversions.
• ProductEntitlementPlanId: integer (int64)
  Title: Product Entitlement Plan ID

  The unique identifier of the product entitlement plan record of UOM conversions.
• StartDate: string (date)
  Title: Start Date

  The start date from the UOM conversion row starts active.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product of UOM conversions.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 25

  The name of the unit of measure provided by user for UOM conversions.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The code of the unit of measure provided by user for UOM conversions.
• UOMConversionRate: number
  Title: Conversion Rate

  The conversion rate of UOM code to charge UOM code.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the UOM conversion row is active or not.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the balance code name of the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of balance code identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of balance profile identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code associated to the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition identifier associated to the UOM conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge",
            "maxLength":80,
            "type":"string",
            "description":"The name of the charge associated to the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargeUOMCode":{
            "title":"Charge UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code of the charge associated to the UOM conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date till the UOM conversion row remains active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EntitlementPlanUOMConversionId":{
            "title":"UOM Conversion ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan UOM conversions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EntitlementPlanUOMConversionNumber":{
            "title":"UOM Conversion Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of entitlement plan UOM conversions.",
            "nullable":true
        },
        "ProductEntitlementPlanId":{
            "title":"Product Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of the product entitlement plan record of UOM conversions.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date from the UOM conversion row starts active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product of UOM conversions.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code of the unit of measure provided by user for UOM conversions.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "UOMConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion rate of UOM code to charge UOM code.",
            "nullable":false,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"The name of the unit of measure provided by user for UOM conversions.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

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 : subscriptionEntitlementPlans-UOMConversions-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the UOM conversion row is active or not.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  Indicates the balance code name of the UOM conversion.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The unique identifier of balance code identifier associated to the UOM conversion.
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of balance profile identifier associated to the UOM conversion.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code associated to the UOM conversion.
• ChargeDefinitionId: integer
  Title: Charge Definition ID

  The unique identifier of charge definition identifier associated to the UOM conversion.
• ChargeName: string
  Title: Charge

  Maximum Length: 80

  The name of the charge associated to the UOM conversion.
• ChargeUOMCode: string
  Title: Charge UOM

  Maximum Length: 3

  The code of the charge associated to the UOM conversion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date of creation of the subscription entitlement plan UOM conversions.
• EndDate: string (date)
  Title: End Date

  The end date till the UOM conversion row remains active.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The unique identifier of entitlement plan identifier associated to the UOM conversion.
• EntitlementPlanUOMConversionId: integer (int64)
  Title: UOM Conversion ID

  The unique identifier of entitlement plan UOM conversions.
• EntitlementPlanUOMConversionNumber: string
  Title: UOM Conversion Number

  Maximum Length: 120

  The unique number of entitlement plan UOM conversions.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  The user who last updated the subscription entitlement plan UOM conversions.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  The version number of the subscription entitlement plan UOM conversions.
• ProductEntitlementPlanId: integer (int64)
  Title: Product Entitlement Plan ID

  The unique identifier of the product entitlement plan record of UOM conversions.
• StartDate: string (date)
  Title: Start Date

  The start date from the UOM conversion row starts active.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product of UOM conversions.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  The unique number of the subscription product of UOM conversions.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 25

  The name of the unit of measure provided by user for UOM conversions.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The code of the unit of measure provided by user for UOM conversions.
• UOMConversionRate: number
  Title: Conversion Rate

  The conversion rate of UOM code to charge UOM code.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the UOM conversion row is active or not.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the balance code name of the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of balance code identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of balance profile identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code associated to the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition identifier associated to the UOM conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge",
            "maxLength":80,
            "type":"string",
            "description":"The name of the charge associated to the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeUOMCode":{
            "title":"Charge UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code of the charge associated to the UOM conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan UOM conversions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan UOM conversions.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date till the UOM conversion row remains active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanUOMConversionId":{
            "title":"UOM Conversion ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan UOM conversions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanUOMConversionNumber":{
            "title":"UOM Conversion Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of entitlement plan UOM conversions.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan UOM conversion was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan UOM conversions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription entitlement plan UOM conversions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the subscription entitlement plan UOM conversions.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProductEntitlementPlanId":{
            "title":"Product Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of the product entitlement plan record of UOM conversions.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date from the UOM conversion row starts active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product of UOM conversions.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription product of UOM conversions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code of the unit of measure provided by user for UOM conversions.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "UOMConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion rate of UOM code to charge UOM code.",
            "nullable":false,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"The name of the unit of measure provided by user for UOM conversions.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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"
    }
}

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."
        }
    }
}

Back to Top