Jump to

• Request
• Response
• Examples

Update a resource for a territory

patch

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerritoryResourceUniqID}

Request

Path Parameters

• TerritoryResourceUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Resources resource and used to uniquely identify an instance of Resources. The client should not generate the hash key value. Instead, the client should query on the Resources collection resource in order to navigate to a specific instance of Resources to get the hash key.
• TerritoryVersionId(required): integer(int64)
  The unique identifier of the territory version.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdministratorFlag: boolean
  Title: Team Member Administrator

  Maximum Length: 1

  Indicates whether the resource is an administrator of the territory.
• FunctionCode: string
  Title: Team Member Function

  Maximum Length: 30

  The code for the function of the resource associated with the territory.
• ManageForecastFlag: boolean
  Title: Forecasting Delegate

  Maximum Length: 1

  Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the resource from the resource manager.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of the territory version.

{
    "type":"object",
    "properties":{
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":30,
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "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 : territories-TerritoryResource-item-response

Type: object

Show Source

• AdministratorFlag: boolean
  Title: Team Member Administrator

  Maximum Length: 1

  Indicates whether the resource is an administrator of the territory.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the territory team member.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the territory team member was created.
• Email: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the territory team member.
• FunctionCode: string
  Title: Team Member Function

  Maximum Length: 30

  The code for the function of the resource associated with the territory.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory team member was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the territory team member.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory team member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManageForecastFlag: boolean
  Title: Forecasting Delegate

  Maximum Length: 1

  Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.
• Manager: string
  Read Only: true

  Maximum Length: 360

  The name of the manager.
• OrganizationName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  The name of the organization.
• OwnerFlag: boolean
  Title: Owner

  Read Only: true

  Indicates whether the territory team member is the owner.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the resource from the resource manager.
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 360

  The name of the resource associated with the territory.
• ResourceNumber: string
  Title: Resource Registry ID

  Read Only: true

  Maximum Length: 30

  The registry ID of the territory team member.
• RoleName: string
  Title: Team Member Role

  Read Only: true

  Maximum Length: 60

  The name of the team member role associated with the resource.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of the territory version.
• TerrResourceId: integer (int64)
  Title: Territory Resource ID

  The unique identifier of the territory resource.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The unique territory number of the territory team member.

{
    "type":"object",
    "properties":{
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory team member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":30,
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory team member 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 territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Manager":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"The name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the territory team member is the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the resource associated with the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The registry ID of the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Team Member Role",
            "maxLength":60,
            "type":"string",
            "description":"The name of the team member role associated with the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerrResourceId":{
            "title":"Territory Resource ID",
            "type":"integer",
            "description":"The unique identifier of the territory resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique territory number of the territory team member.",
            "nullable":true,
            "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

LookupFunctionCodeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOT_TEAM_MEMBER_FUNCTION

The list of values for the role or function of the resource associated with the territory, such as Legal or Salesperson.

The following properties are defined on the LOV link relation:

• Source Attribute: FunctionCode; Target Attribute: LookupCode
• Display Attribute: Meaning

LookupYesNoViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The list of values to indicate whether the resource is an administrator of the territory or not. The valid values are Yes and No.

The following properties are defined on the LOV link relation:

• Source Attribute: AdministratorFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to update a resource for a territory by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503

Example of Request Body

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

{
  "ManageForecastFlag":"true"
}

Example of Response Body

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

{
"TerrResourceId": 300100091635503,
"ResourceId": 100010025532672,
"ResourceName": "Gabrielle Lee",
"TerritoryVersionId": 300100091635502,
"FunctionCode": null,
"OrganizationName": null,
"RoleName": null,
"ManageForecastFlag": true,
"AdministratorFlag": null,
"Manager": null,
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503",…},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503",…},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502",…},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503/lov/LookupFunctionCodeViewAccessor",…},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503/lov/LookupYesNoViewAccessor",…}
]
}

Back to Top