Jump to

• Request
• Response

Create an escalation level

post

/crmRestApi/resources/11.13.18.05/escalationLevels

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

• ApprovalRequiredFlag: boolean
  Title: Approval Required Flag

  Maximum Length: 1

  Default Value: false

  Flag which identifies if the escalation needs approval
• BUOrgId: integer (int64)
  Title: Business Unit ID

  Indicates the business unit that escalation level belongs to
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates if the escalation level is deleted or not
• EscalationLevelId: integer (int64)
  Title: Escalation Level ID

  Unique Identifier for escalation level
• EscalationLevelLabel: string
  Title: Escalation Level Label

  Maximum Length: 30

  Label for the escalation level
• EscalationLevelNumber: string
  Title: Escalation Level Number

  Maximum Length: 30

  System generated PUID for escalation level
• EscalationLevelOrder: integer (int32)
  Title: Escalation Level Order

  Indicates the order of the escalation
• EscalationName: string
  Title: Escalation Name

  Maximum Length: 400

  Indicates the name of the escalation
• ObjectTypeCd: string
  Title: Object Type Code

  Maximum Length: 30

  Indicates the object to which escalation belongs to
• ScheduleId: integer (int64)
  Title: Schedule ID

  Indicates the escalation schedule

{
    "type":"object",
    "properties":{
        "ApprovalRequiredFlag":{
            "title":"Approval Required Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag which identifies if the escalation needs approval",
            "nullable":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"YES_NO",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Indicates the business unit that escalation level belongs to",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the escalation level is deleted or not",
            "nullable":false,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"YES_NO",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "EscalationLevelId":{
            "title":"Escalation Level ID",
            "type":"integer",
            "description":"Unique Identifier for escalation level",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EscalationLevelLabel":{
            "title":"Escalation Level Label",
            "maxLength":30,
            "type":"string",
            "description":"Label for the escalation level",
            "nullable":false
        },
        "EscalationLevelNumber":{
            "title":"Escalation Level Number",
            "maxLength":30,
            "type":"string",
            "description":"System generated PUID for escalation level",
            "nullable":false
        },
        "EscalationLevelOrder":{
            "title":"Escalation Level Order",
            "type":"integer",
            "description":"Indicates the order of the escalation",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "EscalationName":{
            "title":"Escalation Name",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the name of the escalation",
            "nullable":false
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the object to which escalation belongs to",
            "nullable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"Indicates the escalation schedule",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• ApprovalRequiredFlag: boolean
  Title: Approval Required Flag

  Maximum Length: 1

  Default Value: false

  Flag which identifies if the escalation needs approval
• BUOrgId: integer (int64)
  Title: Business Unit ID

  Indicates the business unit that escalation level belongs to
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates the user who created the escalation level
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Indicates the date when the escalation level was created
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates if the escalation level is deleted or not
• EscalationLevelId: integer (int64)
  Title: Escalation Level ID

  Unique Identifier for escalation level
• EscalationLevelLabel: string
  Title: Escalation Level Label

  Maximum Length: 30

  Label for the escalation level
• EscalationLevelNumber: string
  Title: Escalation Level Number

  Maximum Length: 30

  System generated PUID for escalation level
• EscalationLevelOrder: integer (int32)
  Title: Escalation Level Order

  Indicates the order of the escalation
• EscalationName: string
  Title: Escalation Name

  Maximum Length: 400

  Indicates the name of the escalation
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Indicates the date when the escalation level was last updated
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the escalation level
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Indicates the login of the user who last updated the escalation level
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Indicates the object to which escalation belongs to
• ScheduleId: integer (int64)
  Title: Schedule ID

  Indicates the escalation schedule

{
    "type":"object",
    "properties":{
        "ApprovalRequiredFlag":{
            "title":"Approval Required Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag which identifies if the escalation needs approval",
            "nullable":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"YES_NO",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Indicates the business unit that escalation level belongs to",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the escalation level",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Indicates the date when the escalation level was created",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the escalation level is deleted or not",
            "nullable":false,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"YES_NO",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "EscalationLevelId":{
            "title":"Escalation Level ID",
            "type":"integer",
            "description":"Unique Identifier for escalation level",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EscalationLevelLabel":{
            "title":"Escalation Level Label",
            "maxLength":30,
            "type":"string",
            "description":"Label for the escalation level",
            "nullable":false,
            "x-queryable":true
        },
        "EscalationLevelNumber":{
            "title":"Escalation Level Number",
            "maxLength":30,
            "type":"string",
            "description":"System generated PUID for escalation level",
            "nullable":false,
            "x-queryable":true
        },
        "EscalationLevelOrder":{
            "title":"Escalation Level Order",
            "type":"integer",
            "description":"Indicates the order of the escalation",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "EscalationName":{
            "title":"Escalation Name",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the name of the escalation",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Indicates the date when the escalation level was last updated",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Indicates the login of the user who last updated the escalation level",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the escalation level",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the object to which escalation belongs to",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"Indicates the escalation schedule",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Links

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: DeletedFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top