Jump to

• Request
• Response
• Examples

Create a proposal

post

/crmRestApi/resources/11.13.18.05/proposals

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

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ActFailureReasonCode":{
            "title":"Failure Reason Code",
            "maxLength":60,
            "type":"string",
            "description":"The code indicating the reason for failure of the proposal activation.",
            "nullable":true
        },
        "ActivationDateTime":{
            "type":"string",
            "description":"The date when the proposal is activated.",
            "format":"date-time",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the proposal and its intended changes.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the proposal.",
            "nullable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the resource who initiated the proposal, typically the owner of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartitionCode":{
            "title":"Partition Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"PRODUCTION"
        },
        "ProposalNumber":{
            "title":"Proposal Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the proposal.",
            "nullable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the proposal. For example, DRAFT or PENDING ACTIVATION.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerrProposalId":{
            "title":"Territory Proposal ID",
            "type":"integer",
            "description":"The unique identifier of the proposal.",
            "format":"int64",
            "nullable":false,
            "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 : proposals-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ActFailureReasonCode":{
            "title":"Failure Reason Code",
            "maxLength":60,
            "type":"string",
            "description":"The code indicating the reason for failure of the proposal activation.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivationDateTime":{
            "type":"string",
            "description":"The date when the proposal is activated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a proposal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the proposal and its intended changes.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the proposal.",
            "nullable":false,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The display name for the initiator of the proposal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the resource who initiated the proposal, typically the owner of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerNumber":{
            "title":"Owner Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The number of the owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartitionCode":{
            "title":"Partition Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"PRODUCTION",
            "x-queryable":true
        },
        "ProposalNumber":{
            "title":"Proposal Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the proposal.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the proposal. For example, DRAFT or PENDING ACTIVATION.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerrProposalId":{
            "title":"Territory Proposal ID",
            "type":"integer",
            "description":"The unique identifier of the proposal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether a proposal can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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

Examples

The following example shows how to create a proposal by submitting a POST 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 POST "https://servername.fa.us2.oraclecloud.com/crmPerformanceApi/resources/11.13.0.0/proposals/"  -d '{request_payload}'

Example of Request Body

The following example shows the contents of the request body in JSON format:

{
"Name":"Rest Proposals",
"ActivationDateTime":"2016-12-11T00:00:00-07:00"
}

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": "DRAFT",
"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/crmPerformanceApi/resources/11.13.0.0/proposals/300100129032294",},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmPerformanceApi/resources/11.13.0.0/proposals/300100129032294",},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmPerformanceApi/resources/11.13.0.0/proposals/300100129032294/lov/ValidStatusCodeViewAccessor",…}
]
}

Back to Top