Jump to

• Request
• Response
• Examples

Create a partner account team member for a partner

post

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers

Request

Path Parameters

• CompanyNumber(required): string
  The alternate key identifier of the partner's company.

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.
• Upsert-Mode:
  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

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  Default Value: 300

  The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• AssignmentTypeCode: string
  Title: Assignment Type

  Maximum Length: 30

  Default Value: MANUAL

  The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• OrganizationRole: string
  Title: Title

  The role of the resource in the organization.
• OwnerIndicator: string
  Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.
• PartnerAccountResourceId: integer (int64)
  Title: Partner Account Resource ID

  The unique identifier of the party that owns the partner.
• PartnerCompanyNumber: string
  Title: Partner Number

  Maximum Length: 30

  The unique identifier of the partner company.
• ResourceId: integer (int64)
  Title: Account Team Member

  The unique identifier of the sale profile of the resource.

{
    "type":"object",
    "properties":{
        "OwnerIndicator":{
            "type":"string",
            "description":"Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.",
            "nullable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"300",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "ResourceId":{
            "title":"Account Team Member",
            "type":"integer",
            "description":"The unique identifier of the sale profile of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationRole":{
            "title":"Title",
            "type":"string",
            "description":"The role of the resource in the organization.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the partner company.",
            "nullable":false
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"MANUAL"
        },
        "PartnerAccountResourceId":{
            "title":"Partner Account Resource ID",
            "type":"integer",
            "description":"The unique identifier of the party that owns the partner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":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 : partners-accountTeamMembers-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  Default Value: 300

  The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• AssignmentTypeCode: string
  Title: Assignment Type

  Maximum Length: 30

  Default Value: MANUAL

  The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• 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 and time the record was created.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the resource.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  The formatted version of the address.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the resource.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which 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 details of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• OrganizationRole: string
  Title: Title

  The role of the resource in the organization.
• OwnerIndicator: string
  Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.
• PartnerAccountResourceId: integer (int64)
  Title: Partner Account Resource ID

  The unique identifier of the party that owns the partner.
• PartnerCompanyNumber: string
  Title: Partner Number

  Maximum Length: 30

  The unique identifier of the partner company.
• ResourceId: integer (int64)
  Title: Account Team Member

  The unique identifier of the sale profile of the resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the resource.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The party number for the resource of the partner account team.

{
    "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 and time the record was created.",
            "format":"date-time",
            "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
        },
        "OwnerIndicator":{
            "type":"string",
            "description":"Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"300",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The formatted version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyCountry",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "OrganizationRole":{
            "title":"Title",
            "type":"string",
            "description":"The role of the resource in the organization.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"MANUAL",
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PartnerAccountResourceId":{
            "title":"Partner Account Resource ID",
            "type":"integer",
            "description":"The unique identifier of the party that owns the partner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "title":"Account Team Member",
            "type":"integer",
            "description":"The unique identifier of the sale profile of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The party number for the resource of the partner account team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "="
                ],
                "dependencies":[
                    "PrimaryPhoneCountryCode",
                    "PrimaryPhoneAreaCode",
                    "PrimaryPhoneNumber",
                    "PrimaryPhoneExtension",
                    "PrimaryPhoneLineType",
                    "PrimaryPhoneContactPtId",
                    "PersonalPhoneFlag"
                ]
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which 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 details 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."
        }
    }
}

Links

accessLevelsLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ACCESS_LEVEL%2CBindLookupCode%3D{AccessLevelCode}

The lookups resource is used to view standard lookup codes.

assignmentTypesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ASSIGNMENT_TYPE%2CBindLookupCode%3D{AssignmentTypeCode}

The lookups resource is used to view standard lookup codes.

memberFunctionsLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_RESOURCE_FUNCTION%2CBindLookupCode%3D{MemberFunctionCode}

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

cURL Command

The following example shows how to create a partner account team member for a partner by submitting a post request on the REST resource using cURL.

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/100001/child/accountTeamMembers

Example of Request Body

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

{     
   "ResourceId":"100010025532534"
  }

Example of Response Body

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

{
  "items" : [ {
    "PartnerAccountResourceId" : 300100003284977,
    "PartnerAccountId" : 100000020252061,
    "ResourceId" : 100010025532534,
    "PartnerPartyId" : 100000016934002,
    "OrganizationName" : "Channel Account Org A",
    "OrganizationRole" : "Channel Account Manager",
    "TerritoryName" : null,
    "ResourceName" : "Account_MgrENT1 CAM",
    "AccessLevelCode" : "300",
    "AssignmentTypeCode" : "MANUAL",
    "MemberFunctionCode" : "CHANNEL_MGR",
    "EmailAddress" : "[e-mail]",
    "FormattedPhoneNumber" : null,
   ...,  
}

Back to Top