Jump to

• Request
• Response

Update a smart text user variable

patch

/crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}

Request

Path Parameters

• VariableId(required): integer(int64)
  The unique identifier of the smart text user variable.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attribute: string
  Maximum Length: 50

  The field or attribute of the object that holds the value for substitution.
• BuOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit organization for the user variable.
• Context: string
  Title: Domain

  Maximum Length: 50

  Default Value: ORA_SVC_SR

  The application or context with which this variable is used.
• Description: string
  Maximum Length: 50

  The short description of the variable.
• Object: string
  Title: Object

  Maximum Length: 150

  This is the reference to the object that holds the value for substituting the variable.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The lookup code that indicates the stripe code, such as CRM, HCM, or PRM.
• SubstitutionMethod: string
  Maximum Length: 255

  Default Value: Prompt

  The descriptive value for the method used for derivation. Values include 'Prompt', 'Value' and 'Eval'.
• ValChar: string
  Title: Value

  Maximum Length: 150

  The static character value for the variable substitution.
• VariableCode: string
  Title: Variable

  Maximum Length: 50

  The variable that is displayed in the UI for context substitution into actual value.
• VariableNumber: string
  Maximum Length: 30

  The public surrogate key.

{
    "type":"object",
    "properties":{
        "Context":{
            "title":"Domain",
            "maxLength":"50",
            "type":"string",
            "description":"The application or context with which this variable is used.",
            "nullable":false,
            "default":"ORA_SVC_SR",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VariableCode":{
            "title":"Variable",
            "maxLength":"50",
            "type":"string",
            "description":"The variable that is displayed in the UI for context substitution into actual value.",
            "nullable":false
        },
        "Description":{
            "maxLength":"50",
            "type":"string",
            "description":"The short description of the variable.",
            "nullable":true
        },
        "Attribute":{
            "maxLength":"50",
            "type":"string",
            "description":"The field or attribute of the object that holds the value for substitution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubstitutionMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"The descriptive value for the method used for derivation. Values include 'Prompt', 'Value' and 'Eval'.",
            "nullable":true,
            "default":"Prompt",
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code that indicates the stripe code, such as CRM, HCM, or PRM.",
            "nullable":false
        },
        "ValChar":{
            "title":"Value",
            "maxLength":"150",
            "type":"string",
            "description":"The static character value for the variable substitution.",
            "nullable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":"150",
            "type":"string",
            "description":"This is the reference to the object that holds the value for substituting the variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the user variable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "VariableNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The public surrogate key.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• Attribute: string
  Maximum Length: 50

  The field or attribute of the object that holds the value for substitution.
• BuOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit organization for the user variable.
• Context: string
  Title: Domain

  Maximum Length: 50

  Default Value: ORA_SVC_SR

  The application or context with which this variable is used.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the smart text user variable.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the smart text user variable was created.
• Description: string
  Maximum Length: 50

  The short description of the variable.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the smart text user variable was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the smart text user variable.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the smart text user variable.
• links: array Links
  Title: Links

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

  Maximum Length: 150

  This is the reference to the object that holds the value for substituting the variable.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The lookup code that indicates the stripe code, such as CRM, HCM, or PRM.
• SubstitutionMethod: string
  Maximum Length: 255

  Default Value: Prompt

  The descriptive value for the method used for derivation. Values include 'Prompt', 'Value' and 'Eval'.
• ValChar: string
  Title: Value

  Maximum Length: 150

  The static character value for the variable substitution.
• VariableCode: string
  Title: Variable

  Maximum Length: 50

  The variable that is displayed in the UI for context substitution into actual value.
• VariableId: integer (int64)
  Title: Variable ID

  Read Only: true

  The unique identifier of the smart text user variable.
• VariableNumber: string
  Maximum Length: 30

  The public surrogate key.
• VariableUniqueNumber: string
  Maximum Length: 30

  The public unique surrogate key which is required.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the smart text user variable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Context":{
            "title":"Domain",
            "maxLength":"50",
            "type":"string",
            "description":"The application or context with which this variable is used.",
            "nullable":false,
            "default":"ORA_SVC_SR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the smart text user variable was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the smart text user variable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VariableCode":{
            "title":"Variable",
            "maxLength":"50",
            "type":"string",
            "description":"The variable that is displayed in the UI for context substitution into actual value.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"50",
            "type":"string",
            "description":"The short description of the variable.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute":{
            "maxLength":"50",
            "type":"string",
            "description":"The field or attribute of the object that holds the value for substitution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VariableNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The public surrogate key.",
            "nullable":true,
            "x-queryable":true
        },
        "VariableUniqueNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The public unique surrogate key which is required.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstitutionMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"The descriptive value for the method used for derivation. Values include 'Prompt', 'Value' and 'Eval'.",
            "nullable":true,
            "default":"Prompt",
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code that indicates the stripe code, such as CRM, HCM, or PRM.",
            "nullable":false,
            "x-queryable":true
        },
        "ValChar":{
            "title":"Value",
            "maxLength":"150",
            "type":"string",
            "description":"The static character value for the variable substitution.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Object":{
            "title":"Object",
            "maxLength":"150",
            "type":"string",
            "description":"This is the reference to the object that holds the value for substituting the variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VariableId":{
            "title":"Variable ID",
            "type":"integer",
            "description":"The unique identifier of the smart text user variable.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the user variable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the smart text user variable was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the smart text user variable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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