Jump to

• Request
• Response
• Examples

Create a sales lead resource

post

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources

Request

Path Parameters

• leadsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads 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

  Default Value: FULL

  The code indicating the access level of a team member.
• ConflictId: integer (int64)
  Title: Conflict Identifier

  Default Value: 1

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• FunctionalRole: string
  Title: Function

  Maximum Length: 30

  The role played by this Sale team resource for the handling of this sales lead.
• LeadId: integer
  Title: Lead ID

  The unique identifier of the sales lead for this sales lead resource.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The alternate unique identifier of the lead.
• LeadResourceId: integer
  Title: Lead Resource ID

  The unique identifier of the sales lead resource.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.
• ResourceId: integer
  Title: Resource ID

  The unique identifier associated with this sales lead resource.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"FULL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales lead resource.",
            "nullable":false,
            "x-hints":{
                "RecentItemEntityName":"resources"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead resource.",
            "nullable":false
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role played by this Sale team resource for the handling of this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadResourceId":{
            "title":"Lead Resource ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead resource.",
            "nullable":false
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "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 : leads-MklLeadResources-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  Default Value: FULL

  The code indicating the access level of a team member.
• ConflictId: integer (int64)
  Title: Conflict Identifier

  Default Value: 1

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created this sales lead resource.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when this sales lead resource is created.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The e-mail address associated with the sales lead team resource.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the lead sales team resource.
• FunctionalRole: string
  Title: Function

  Maximum Length: 30

  The role played by this Sale team resource for the handling of this sales lead.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time of the last update of the sales lead resource.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the sales lead resource.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LeadId: integer
  Title: Lead ID

  The unique identifier of the sales lead for this sales lead resource.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The alternate unique identifier of the lead.
• LeadResourceId: integer
  Title: Lead Resource ID

  The unique identifier of the sales lead resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerName: string
  Title: Manager Name

  Read Only: true

  Maximum Length: 360

  The name of the sales lead manager.
• Name: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  The name of the sales lead resource.
• PartyName: string
  Title: Team Member

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the sales lead resource.
• PartyNumber: string
  Title: Resource Party Number

  Read Only: true

  Maximum Length: 30

  The contact number of the party associated with the lead resource.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.
• PrimaryPhonePurpose: string
  Title: Role

  Read Only: true

  Maximum Length: 30

  The type of contact point used for updating underlying contact point TCA data.
• ResourceId: integer
  Title: Resource ID

  The unique identifier associated with this sales lead resource.
• ResourceOrgId: integer (int64)
  Title: Resource Organization ID

  Read Only: true

  The unique identifier of the resource organization associated with this sales lead resource.
• RoleName: string
  Title: Role

  Read Only: true

  Maximum Length: 60

  The name of the role of the sales lead resource associated with the sales lead.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales lead resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead resource is created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this sales lead resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"FULL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the sales lead manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Team Member",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the sales lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role played by this Sale team resource for the handling of this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address associated with the sales lead team resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "LeadResourceId":{
            "title":"Lead Resource ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the sales lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceOrgId":{
            "title":"Resource Organization ID",
            "type":"integer",
            "description":"The unique identifier of the resource organization associated with this sales lead resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RoleName":{
            "title":"Role",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role of the sales lead resource associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The contact number of the party associated with the lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales lead resource.",
            "nullable":false,
            "x-hints":{
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead resource.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryPhonePurpose":{
            "title":"Role",
            "maxLength":"30",
            "type":"string",
            "description":"The type of contact point used for updating underlying contact point TCA data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead sales team resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead resource.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

AccessVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The lookups resource is used to view standard lookup codes.

HzLookupPVO1

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Back to Top

Examples

cURL Command

The following example shows how to create a sales lead resource by submitting a POST request on the REST resource using cURL.

curl -u <username:password> \ -X POST -d @example_request_payload.json -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/

Example of Request Body

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

{"ResourceId" : 100010032635399}

Example of Response Body

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

{
  "LeadResourceId" : 300100092582213,
  "CreatedBy" : "MHoope",
  "CreationDate" : "2016-11-07T05:20:20-08:00",
  "LastUpdateDate" : "2016-11-07T05:20:20-08:00",
  "LastUpdatedBy" : "MHoope",
  "PrimaryFlag" : false,
  "FunctionalRole" : null,
  "ResourceId" : 100010032635399,
  "LeadId" : 300100092582093,
  "ResourceOrgId" : 100000015105001,
  "EmailAddress" : "[e-mail]",
  "PartyName" : "Dan Foreman",
  "PrimaryPhonePurpose" : "BUSINESS",
  "RoleName" : "Salesperson",
  "ManagerName" : "Todd Beeler",
  "FormattedPhoneNumber" : "[phone]",
  "Name" : "APAC Commercial",
  "PartyNumber" : "100010032635399",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/300100092582213",
    "name" : "MklLeadResources",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/300100092582213",
    "name" : "MklLeadResources",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100092582093",
    "name" : "leads",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/300100092582213/lov/HzLookupPVO1",
    "name" : "HzLookupPVO1",
    "kind" : "Collection"
  } ]
}

Back to Top