Jump to

• Request
• Response
• Examples

Create a deal team member

post

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources

Request

Path Parameters

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

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

  The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.
• DealId: integer (int64)
  The unique identifier of the deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  Public Unique Identifier of Deal Registration on the Deal Resource Team
• DealResourceId: integer (int64)
  The unique identifier of the deal team member.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether the deal team member is the owner of the deal registration.
• PartnerOrgId: integer (int64)
  The unique identifier of the partner organization.
• ResourceId: integer (int64)
  The unique identifier of the employee resource.
• ResourceUsername: string
  Title: User Name

  The login username of the deal team member associated with the deal registration.

{
    "type":"object",
    "properties":{
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the employee resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealResourceId":{
            "type":"integer",
            "description":"The unique identifier of the deal team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier of Deal Registration on the Deal Resource Team",
            "nullable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the deal team member is the owner of the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceUsername":{
            "title":"User Name",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : deals-DealResources-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the deal team member record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the deal team member record was created.
• DealId: integer (int64)
  The unique identifier of the deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  Public Unique Identifier of Deal Registration on the Deal Resource Team
• DealResourceId: integer (int64)
  The unique identifier of the deal team member.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the deal team member associated with the deal registration.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the deal team member associated with the deal registration.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the deal team member record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the deal team member record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the deal team member 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 function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether the deal team member is the owner of the deal registration.
• PartnerOrgId: integer (int64)
  The unique identifier of the partner organization.
• ResourceId: integer (int64)
  The unique identifier of the employee resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the deal team member associated with the deal registration.
• ResourcePartyNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Resource Party on the Deal Resource Team
• ResourceUsername: string
  Title: User Name

  The login username of the deal team member associated with the deal registration.
• RoleName: string
  Read Only: true

  Maximum Length: 255

  The login username of the deal team member associated with the deal registration.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the deal team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the deal team member record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the deal team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the deal team member associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier of Deal Registration on the Deal Resource Team",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the deal team member is the owner of the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "ResourceUsername":{
            "title":"User Name",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "RoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the employee resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealResourceId":{
            "type":"integer",
            "description":"The unique identifier of the deal team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier of Resource Party on the Deal Resource Team",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.",
            "nullable":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"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryPhoneCountryCode",
                    "PrimaryPhoneAreaCode",
                    "PrimaryPhoneNumber",
                    "PrimaryPhoneExtension",
                    "PrimaryPhoneLineType",
                    "PrimaryPhonePurpose",
                    "PrimaryPhoneContactPtId"
                ]
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the deal team member 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 deal team member 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

AccessLevelCodesVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The lookups resource is used to view standard lookup codes.

MemberFunctionCodesVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DZCA_RESOURCE_FUNCTION

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to create a deal team member 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/deals/300100071405733/child/DealResources

Example of Request Body

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

{
   "ResourceId": 100000016934086,
   "AccessLevelCode": "200"
}

Example of Response Body

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

{
  DealResourceId: 300100071405737
  DealId: 300100071405733
  ResourceId: 100000016934086
  AccessLevelCode: "200"
  OwnerFlag: false
  ResourceName: "Anthony Mason"
  ResourceUsername: "AMASON"
  ...
}

Back to Top