Jump to

• Request
• Response
• Examples

Get a proposal

get

/crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}

Request

Path Parameters

• TerrProposalId(required): integer(int64)
  The unique identifier of the proposal.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "Owner":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The display name for the initiator of the proposal.",
            "nullable":false,
            "readOnly":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
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"A brief description of the proposal and its intended changes.",
            "nullable":true,
            "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
        },
        "ActivationDateTime":{
            "type":"string",
            "description":"The date when the proposal is activated.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a proposal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the proposal.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether a proposal can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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"
            },
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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 get a proposal by submitting a GET request on the REST resource using cURL.

cURL Command

curl -v -u sales_cloud_user -X GET "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/100000019442529"

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items":[
{
"TerrProposalId": 100000019442529,
"Name": "Forecasting Updates Aug 20 2010",
"Description": "Temporary Owner changes for B14 Forecasting. Updates to APAC. Henderson replaces Anderson. ",
"StatusCode": "ACTIVATED",
"OwnerId": 100010025532672,
"Owner": "Gabrielle Lee",
"PartitionCode": "PRODUCTION",
"ActFailureReasonCode": null,
"ProposalNumber": "CDRM_1",
"ActivationDateTime": "2010-08-20T00:00:00-07:00",
"UpdateFlag": true,
"DeleteFlag": true,
"links":[{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/100000019442529",…]
}

Back to Top