Update a proposal
patch
/crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}
Request
Path Parameters
-
TerrProposalId(required): integer(int64)
The unique identifier of the proposal.
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
Root Schema : schema
Type:
Show Source
object
-
ActFailureReasonCode: string
Title:
Failure Reason Code
Maximum Length:60
The code indicating the reason for failure of the proposal activation. -
ActivationDateTime: string
(date-time)
The date when the proposal is activated.
-
Description: string
Title:
Description
Maximum Length:240
A brief description of the proposal and its intended changes. -
Name: string
Title:
Name
Maximum Length:60
The name of the proposal. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the resource who initiated the proposal, typically the owner of the territory. -
PartitionCode: string
Title:
Partition Type
Maximum Length:30
Default Value:PRODUCTION
The code indicating whether or not the proposal is an error correction proposal for territories that were made invalid by dimension, or member changes, by recording whether the proposal is in the Stage or Production partition. The default value is PRODUCTION. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the proposal. For example, DRAFT or PENDING ACTIVATION.
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 : proposals-item-response
Type:
Show Source
object
-
ActFailureReasonCode: string
Title:
Failure Reason Code
Maximum Length:60
The code indicating the reason for failure of the proposal activation. -
ActivationDateTime: string
(date-time)
The date when the proposal is activated.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether a proposal can be deleted. -
Description: string
Title:
Description
Maximum Length:240
A brief description of the proposal and its intended changes. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:60
The name of the proposal. -
Owner: string
Title:
Owner
Read Only:true
Maximum Length:360
The display name for the initiator of the proposal. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the resource who initiated the proposal, typically the owner of the territory. -
OwnerNumber: string
Title:
Owner Registry ID
Read Only:true
Maximum Length:30
The number of the owner. -
PartitionCode: string
Title:
Partition Type
Maximum Length:30
Default Value:PRODUCTION
The code indicating whether or not the proposal is an error correction proposal for territories that were made invalid by dimension, or member changes, by recording whether the proposal is in the Stage or Production partition. The default value is PRODUCTION. -
ProposalNumber: string
Title:
Proposal Number
Maximum Length:30
The alternate key identifier of the proposal. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the proposal. For example, DRAFT or PENDING ACTIVATION. -
TerrProposalId: integer
(int64)
Title:
Territory Proposal ID
The unique identifier of the proposal. -
UpdateFlag: boolean
Read Only:
true
Indicates whether a proposal 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.
Examples
The following example shows how to update a proposal by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -v -u sales_cloud_user -H "content-type:application/vnd.oracle.adf.resourceitem+json" -X PATCH "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294" -d '{request_payload}'
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "StatusCode":"PENDING ACTIVATION" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "TerrProposalId": 300100129032294, "Name": "Rest Proposals", "Description": null, "StatusCode": "PENDING ACTIVATION", "OwnerId": 100010025532672, "Owner": "Gabrielle Lee", "PartitionCode": "PRODUCTION", "ActFailureReasonCode": null, "ProposalNumber": "CDRM_274065", "ActivationDateTime": "2016-12-10T23:00:00-08:00", "UpdateFlag": true, "DeleteFlag": true, "links":[ {"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294",…}, {"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294",…}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294/lov/ValidStatusCodeViewAccessor",…} ] }