Create a case resource
post
/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources
Request
Path Parameters
-
CaseNumber(required): string
The alternate key identifier of the case.
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
-
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
ResourceName: string
Title:
Resource Name
Maximum Length:360
The name of the 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 : cases-caseResources-item-response
Type:
Show Source
object
-
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Maximum Length:30
The alternate key identifier of the case. -
CaseResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the case resource. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the case resource was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the record can be deleted. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the contact who created the resource. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the user who created the resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource for the case was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource for the case. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login session of the user who last updated the resource for the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the resource is the owner of the case. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
ResourceName: string
Title:
Resource Name
Maximum Length:360
The name of the resource. -
ResourcePartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the party. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated.
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.
Links
- ResourcePickerPVO
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesA front office person. For example, sales persons or partner members can be tagged as resources.