Create a resource capacity
post
/crmRestApi/resources/11.13.18.05/resourceCapacities
Request
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
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.
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.
Root Schema : resourceCapacities-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.