Jump to

• Request
• Response

Create a resource capacity

post

/crmRestApi/resources/11.13.18.05/resourceCapacities

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

• CapacityNumber: string
  Title: Resource Capacity Number

  Maximum Length: 30

  The alternate or public unique identifer of the resource capacity.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The channel type a resource can use.
• DecRoutingFlag: boolean
  Maximum Length: 1

  Indicates whether this object type should be routed to Digital Engagement Channels.
• MaximumCapacity: integer (int32)
  Title: Capacity

  The maximum capacity for a resource in a channel type and object type.
• ObjectTypeCd: string
  Title: Business Objects

  Maximum Length: 30

  The object type that you can assign to a resource.
• PartyId: integer (int64)
  Title: Resource ID

  The unique identifier of a resource.

{
    "type":"object",
    "properties":{
        "CapacityNumber":{
            "title":"Resource Capacity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate or public unique identifer of the resource capacity.",
            "nullable":false
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The channel type a resource can use.",
            "nullable":false
        },
        "DecRoutingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this object type should be routed to Digital Engagement Channels.",
            "nullable":true
        },
        "MaximumCapacity":{
            "title":"Capacity",
            "type":"integer",
            "description":"The maximum capacity for a resource in a channel type and object type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "ObjectTypeCd":{
            "title":"Business Objects",
            "maxLength":30,
            "type":"string",
            "description":"The object type that you can assign to a resource.",
            "nullable":true
        },
        "PartyId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of a resource.",
            "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 : resourceCapacities-item-response

Type: object

Show Source

• CapacityId: integer (int64)
  Title: Capacity ID

  Read Only: true

  The unique identifier of the resource capacity.
• CapacityNumber: string
  Title: Resource Capacity Number

  Maximum Length: 30

  The alternate or public unique identifer of the resource capacity.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The channel type a resource can use.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource capacity.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource capacity was created.
• DecRoutingFlag: boolean
  Maximum Length: 1

  Indicates whether this object type should be routed to Digital Engagement Channels.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource capacity was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The session login of the user who last updated the resource capacity.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The user who last updated the resource capacity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCapacity: integer (int32)
  Title: Capacity

  The maximum capacity for a resource in a channel type and object type.
• ObjectTypeCd: string
  Title: Business Objects

  Maximum Length: 30

  The object type that you can assign to a resource.
• PartyId: integer (int64)
  Title: Resource ID

  The unique identifier of a resource.
• ResourceNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the resource.

{
    "type":"object",
    "properties":{
        "CapacityId":{
            "title":"Capacity ID",
            "type":"integer",
            "description":"The unique identifier of the resource capacity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CapacityNumber":{
            "title":"Resource Capacity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate or public unique identifer of the resource capacity.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The channel type a resource can use.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource capacity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource capacity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DecRoutingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this object type should be routed to Digital Engagement Channels.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource capacity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The user who last updated the resource capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The session login of the user who last updated the resource capacity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCapacity":{
            "title":"Capacity",
            "type":"integer",
            "description":"The maximum capacity for a resource in a channel type and object type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Business Objects",
            "maxLength":30,
            "type":"string",
            "description":"The object type that you can assign to a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of a resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the resource.",
            "nullable":false,
            "readOnly":true,
            "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