Jump to

• Request
• Response
• Examples

Create a territory for an opportunity revenue

post

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory

Request

Path Parameters

• ChildRevenueUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Revenue Items resource and used to uniquely identify an instance of Revenue Items. The client should not generate the hash key value. Instead, the client should query on the Revenue Items collection resource in order to navigate to a specific instance of Revenue Items to get the hash key.
• OptyNumber(required): string
  The unique alternate identifier for the opportunity.

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

• EffectiveEndDate: string (date)
  The date when the resource organization assignment to the territory ends.
• EffectiveStartDate: string (date)
  The date when the resource organization for the territory was assigned to the revenue line.
• Name1: string
  Title: Organization

  The name of the organization that the territory resource belongs to.
• RevnId: integer (int64)
  The unique identifier of the revenue.
• RevnTerrId: integer (int64)
  The unique identifier of the revenue territory.
• RoleId: integer
  The unique identifier of the resource's role.
• RoleName: string
  The name of the resource's role.
• TerritoryId: integer (int64)
  The unique identifier of the territory.
• TerritoryVersionId: integer (int64)
  The unique identifier of the territory version.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the resource organization assignment to the territory ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the resource organization for the territory was assigned to the revenue line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Name1":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the organization that the territory resource belongs to.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevnTerrId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "TerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "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 : opportunities-ChildRevenue-RevenueTerritory-item-response

Type: object

Show Source

• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  Maximum Length: 15

  The type of assignment used to assign the territory to the opportunity.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the revenue territory record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• EffectiveEndDate: string (date)
  The date when the resource organization assignment to the territory ends.
• EffectiveStartDate: string (date)
  The date when the resource organization for the territory was assigned to the revenue line.
• ForecastParticipationCode: string
  Title: Forecast Participation

  Read Only: true

  Maximum Length: 30

  The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  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: Revenue Line Territory

  Read Only: true

  Maximum Length: 60

  The name of the territory that the opportunity belongs to.
• Name1: string
  Title: Organization

  The name of the organization that the territory resource belongs to.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the resource who owns the territory.
• PartyName: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The name of the territory owner for the opportunity.
• RevnId: integer (int64)
  The unique identifier of the revenue.
• RevnTerrId: integer (int64)
  The unique identifier of the revenue territory.
• RoleId: integer
  The unique identifier of the resource's role.
• RoleName: string
  The name of the resource's role.
• TerritoryId: integer (int64)
  The unique identifier of the territory.
• TerritoryVersionId: integer (int64)
  The unique identifier of the territory version.
• TypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":15,
            "type":"string",
            "description":"The type of assignment used to assign the territory to the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the revenue territory record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the resource organization assignment to the territory ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the resource organization for the territory was assigned to the revenue line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ForecastParticipationCode":{
            "title":"Forecast Participation",
            "maxLength":30,
            "type":"string",
            "description":"The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Revenue Line Territory",
            "maxLength":60,
            "type":"string",
            "description":"The name of the territory that the opportunity belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "Name1":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the organization that the territory resource belongs to.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource who owns the territory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the territory owner for the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevnTerrId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "TerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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."
        }
    }
}

Links

AssignmentTypeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_TERR_ASSIGNMENT_TYPE

The lookups resource is used to view standard lookup codes.

TerritoryTypeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE%2CBindLookupCode%3D{TypeCode}

The lookups resource is used to view standard lookup codes.

ValidForecastParticipationCodeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DORA_MOT_TERR_ENABLE_FCASTING

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to create a territory for an opportunity revenue by submitting a post request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708/child/ChildRevenue/300100111705696/child/RevenueTerittory

Example of Request Body

The following shows an example of the request body in JSON format.

{
   "TerritoryVersionId": 300100026005983,
   "PartyName": "Gabrielle Lee",
   "TerritoryId": 300100026005982,
   "Name": "APAC Child1"
}

Example of Response Body

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

{
RevnTerrId: 300100111705895
RevnId: 300100111705696
TerritoryId: 300100026005982
TerritoryVersionId: 300100026005983
Name: "APAC Child1ee"
PartyName: "Mathis,Victor"
PartyId: 100010038964209
...
}

Back to Top