Jump to

• Request
• Response

Create a subscription price adjustment variable

post

/crmRestApi/resources/11.13.18.05/subscriptionPriceAdjustmentVariables

Request

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

  Default Value: true

  Indicates whether the subscription price adjustment variable is active or not.
• ObjectVersionNumber: integer (int32)
  The object version number of the subscription price adjustment variable.
• priceAdjustmentVariableValues: array Subscription Price Adjustment Variable Values
  Title: Subscription Price Adjustment Variable Values

  The price adjustment variable values resource stores values for subscription price adjustment variables.
• VariableDescription: string
  Title: Description

  Maximum Length: 240

  Description
• VariableId: integer (int64)
  The unique identifier of the subscription price adjustment variable.
• VariableName(required): string
  Title: Name

  Maximum Length: 100

  The name of the subscription price adjustment variable.
• VariableNumber: string
  Title: Identifier

  Maximum Length: 120

  The number of the subscription price adjustment variable.

{
    "required":[
        "VariableName"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription price adjustment variable is active or not.",
            "nullable":false,
            "default":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription price adjustment variable.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            }
        },
        "VariableDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description",
            "nullable":true
        },
        "VariableId":{
            "type":"integer",
            "description":"The unique identifier of the subscription price adjustment variable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "VariableName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the subscription price adjustment variable.",
            "nullable":false
        },
        "VariableNumber":{
            "title":"Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The number of the subscription price adjustment variable.",
            "nullable":false
        },
        "priceAdjustmentVariableValues":{
            "title":"Subscription Price Adjustment Variable Values",
            "type":"array",
            "description":"The price adjustment variable values resource stores values for subscription price adjustment variables.",
            "items":{
                "$ref":"#/components/schemas/subscriptionPriceAdjustmentVariables-priceAdjustmentVariableValues-item-post-request"
            }
        }
    }
}

Nested Schema : Subscription Price Adjustment Variable Values

Type: array

Title: Subscription Price Adjustment Variable Values

The price adjustment variable values resource stores values for subscription price adjustment variables.

Show Source

• Array of: object schema

{
    "title":"Subscription Price Adjustment Variable Values",
    "type":"array",
    "description":"The price adjustment variable values resource stores values for subscription price adjustment variables.",
    "items":{
        "$ref":"#/components/schemas/subscriptionPriceAdjustmentVariables-priceAdjustmentVariableValues-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The end date of the price adjustment variable value.
• ObjectVersionNumber: integer (int32)
  The object version number of the price adjustment variable value.
• StartDate: string (date)
  Title: Start Date

  The start date of the price adjustment variable value.
• VariableId: integer (int64)
  The identifier of the related subscription price adjustment variable.
• VariableValue: number
  Title: Value

  The value of the price adjustment variable.
• VariableValueId: integer (int64)
  The unique identifier of the price adjustment variable value.
• VariableValuePuid: string
  Title: Identifier

  Maximum Length: 120

  The public unique identifier of the price adjustment variable value.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the price adjustment variable value.",
            "format":"date",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the price adjustment variable value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the price adjustment variable value.",
            "format":"date",
            "nullable":true
        },
        "VariableId":{
            "type":"integer",
            "description":"The identifier of the related subscription price adjustment variable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "VariableValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the price adjustment variable.",
            "nullable":false
        },
        "VariableValueId":{
            "type":"integer",
            "description":"The unique identifier of the price adjustment variable value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "VariableValuePuid":{
            "title":"Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the price adjustment variable value.",
            "nullable":false
        }
    }
}

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 : subscriptionPriceAdjustmentVariables-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the subscription price adjustment variable is active or not.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription price adjustment variable.
• CreationDate: string (date-time)
  Read Only: true

  The creation date of the subscription price adjustment variable.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the subscription price adjustment variable.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription price adjustment variable.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription price adjustment variable.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the subscription price adjustment variable.
• priceAdjustmentVariableValues: array Subscription Price Adjustment Variable Values
  Title: Subscription Price Adjustment Variable Values

  The price adjustment variable values resource stores values for subscription price adjustment variables.
• VariableDescription: string
  Title: Description

  Maximum Length: 240

  Description
• VariableId: integer (int64)
  The unique identifier of the subscription price adjustment variable.
• VariableName: string
  Title: Name

  Maximum Length: 100

  The name of the subscription price adjustment variable.
• VariableNumber: string
  Title: Identifier

  Maximum Length: 120

  The number of the subscription price adjustment variable.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription price adjustment variable is active or not.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription price adjustment variable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The creation date of the subscription price adjustment variable.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the subscription price adjustment variable.",
            "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 price adjustment variable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription price adjustment variable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription price adjustment variable.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "VariableDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description",
            "nullable":true,
            "x-queryable":true
        },
        "VariableId":{
            "type":"integer",
            "description":"The unique identifier of the subscription price adjustment variable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VariableName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the subscription price adjustment variable.",
            "nullable":false,
            "x-queryable":true
        },
        "VariableNumber":{
            "title":"Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The number of the subscription price adjustment variable.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "priceAdjustmentVariableValues":{
            "title":"Subscription Price Adjustment Variable Values",
            "type":"array",
            "description":"The price adjustment variable values resource stores values for subscription price adjustment variables.",
            "items":{
                "$ref":"#/components/schemas/subscriptionPriceAdjustmentVariables-priceAdjustmentVariableValues-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 Price Adjustment Variable Values

Type: array

Title: Subscription Price Adjustment Variable Values

The price adjustment variable values resource stores values for subscription price adjustment variables.

Show Source

• Array of: object subscriptionPriceAdjustmentVariables-priceAdjustmentVariableValues-item-response

{
    "title":"Subscription Price Adjustment Variable Values",
    "type":"array",
    "description":"The price adjustment variable values resource stores values for subscription price adjustment variables.",
    "items":{
        "$ref":"#/components/schemas/subscriptionPriceAdjustmentVariables-priceAdjustmentVariableValues-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 : subscriptionPriceAdjustmentVariables-priceAdjustmentVariableValues-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the price adjustment variable value.
• CreationDate: string (date-time)
  Read Only: true

  The creation date of the price adjustment variable value.
• EndDate: string (date)
  Title: End Date

  The end date of the price adjustment variable value.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the price adjustment variable value.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the price adjustment variable value.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the price adjustment variable value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the price adjustment variable value.
• StartDate: string (date)
  Title: Start Date

  The start date of the price adjustment variable value.
• VariableId: integer (int64)
  The identifier of the related subscription price adjustment variable.
• VariableValue: number
  Title: Value

  The value of the price adjustment variable.
• VariableValueId: integer (int64)
  The unique identifier of the price adjustment variable value.
• VariableValuePuid: string
  Title: Identifier

  Maximum Length: 120

  The public unique identifier of the price adjustment variable value.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the price adjustment variable value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The creation date of the price adjustment variable value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the price adjustment variable value.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the price adjustment variable value.",
            "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 price adjustment variable value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the price adjustment variable value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the price adjustment variable value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the price adjustment variable value.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "VariableId":{
            "type":"integer",
            "description":"The identifier of the related subscription price adjustment variable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VariableValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the price adjustment variable.",
            "nullable":false,
            "x-queryable":true
        },
        "VariableValueId":{
            "type":"integer",
            "description":"The unique identifier of the price adjustment variable value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VariableValuePuid":{
            "title":"Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the price adjustment variable value.",
            "nullable":false,
            "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

priceAdjustmentVariableValues

Operation: /crmRestApi/resources/11.13.18.05/subscriptionPriceAdjustmentVariables/{VariableNumber}/child/priceAdjustmentVariableValues

Parameters:

• VariableNumber: $request.path.VariableNumber

The price adjustment variable values resource stores values for subscription price adjustment variables.

Back to Top