REST API for Oracle Loyalty Cloud

Get all account contacts

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact

Request

Path Parameters

PartyNumber(required): string

The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- AccountContactIdRF :Finds an account contact with the account contact identifier.
  Finder Variables:
  - AccountContactId :The unique identifier of the bind account contact.
- ByAccountHierarchy :Finds the contacts of accounts in hierarchy to the current account.
  Finder Variables:
- ForDuplicateAccounts :Finds the contacts of duplicate accounts related to the current account.
  Finder Variables:
- ForRollup :Finds the AccountContacts associated with the rollups.
  Finder Variables:
  - AttributeName :The rollup attribute name to identify a rollups.
  - RollupId :The unique identifier of a rollup.
- PrimaryKey :Finds an account contact with the specified primary key.
  Finder Variables:
  - AccountContactId :The unique identifier of the account contact.
  - RelationshipRecId :The unique identifier of the relationship record.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AccountContactId; integer; The unique identifier of the account contact.
- AccountName; string; The name of the account.
- AccountPartyId; integer; The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
- AccountPartyNumber; string; The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
- AccountSourceSystem; string; The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
- AccountSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
- AccountUniqueName; string; The unique name of the account.
- Comments; string; The comments of the user.
- ContactFirstName; string; The first name of the contact record.
- ContactLastName; string; The last name of the contact record.
- ContactLastUpdateDate; string; The date when the contact record was last updated.
- ContactName; string; The name of the contact.
- ContactNumber; string; The user-defined identification number for this contact.
- ContactPartyId; integer; The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
- ContactPartyNumber; string; The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
- ContactSourceSystem; string; The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
- ContactSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
- CreatedBy; string; The user who created the row.
- CreatedByModule; string; The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
- CreationDate; string; The date and time when the row was created.
- DecisionMakerFlag; boolean; Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
- Department; string; The free form text used to name the department for the contact.
- DepartmentCode; string; The value of the department code for the contact.
- EmailAddress; string; The e-mail address of the contact person for the account.
- InfluenceLevelCode; string; The contact's level of influence in the buying process.
- JobTitle; string; The free form text for job title for the contact associated to an account.
- JobTitleCode; string; The value of the code for the job title of the contact person.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the row.
- LastUpdatedBy; string; The user who last updated the record.
- PersonBuyingRole; string; Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.
- PersonJobTitle; string; The title of the contact's job with deploying organization.
- PersonSalesAffinityCode; string; The contact's affinity for the deploying organization.
- PreferredContactMethod; string; The person's or organization's preferred contact method.
- ReferenceUseFlag; boolean; Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
- RelationshipId; integer; The unique identifier of the relationship associated with account contact record.
- RelationshipRecId; integer; Finds an account contact with the relationship record identifier.
- RelationshipSourceSystem; string; The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
- RelationshipSourceSystemReferenceValue; string; The identifier for the relationship with the external source system.
- SalesAffinityCode; string; The contact's affinity for the deploying organization.
- SalesAffinityComments; string; The comments describing the contact's affinity for the deploying organization.
- SalesBuyingRoleCode; string; The contact's role in the buying process.
- Status; string; Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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.

Root Schema : accounts-AccountContact

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object accounts-AccountContact-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-item-response"
    }
}

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 : accounts-AccountContact-item-response

Type: object

Show Source

AccountContactId: integer (int64)

Title: Account Contact ID

Read Only: true

The unique identifier of the account contact.
AccountName: string

Title: Account

Read Only: true

Maximum Length: 360

The name of the account.
AccountPartyId: integer (int64)

Title: Account Party ID

The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountPartyNumber: string

Title: Account Party Number

Maximum Length: 30

The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountSourceSystem: string

Title: Account Source System

The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
AccountSourceSystemReferenceValue: string

Title: Account Source System Reference

The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
AccountUniqueName: string

Title: Account

Read Only: true

Maximum Length: 900

The unique name of the account.
Comments: string

Title: Comments

Maximum Length: 2000

The comments of the user.
ContactFirstName: string

Title: First Name

Read Only: true

Maximum Length: 150

The first name of the contact record.
ContactLastName: string

Title: Last Name

Read Only: true

Maximum Length: 150

The last name of the contact record.
ContactLastUpdateDate: string (date-time)

Title: Contact Last Update Date

Read Only: true

The date when the contact record was last updated.
ContactName: string

Title: Name

Read Only: true

Maximum Length: 360

The name of the contact.
ContactNumber: string

Title: Contact Number

Maximum Length: 30

The user-defined identification number for this contact.
ContactPartyId: integer (int64)

Title: Contact Party ID

The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactPartyNumber: string

Title: Contact Party Number

Maximum Length: 30

The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
ContactSourceSystem: string

Title: Contact Source System

The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
ContactSourceSystemReferenceValue: string

Title: Contact Source System Reference

The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the row.
CreatedByModule: string

Title: Created by Application

Maximum Length: 30

Default Value: HZ_WS

The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the row was created.
DecisionMakerFlag: boolean

Title: Decision Maker

Maximum Length: 1

Default Value: false

Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
Department: string

Title: Department

Maximum Length: 60

The free form text used to name the department for the contact.
DepartmentCode: string

Title: Department Code

Maximum Length: 30

The value of the department code for the contact.
DoCallFlag: boolean

Title: OK to Call

Read Only: true

Maximum Length: 10

Default Value: false

Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
DoEmailFlag: boolean

Title: OK to Email

Read Only: true

Maximum Length: 10

Default Value: false

Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
DoNotCallFlag: boolean

Title: Do Not Call

Read Only: true

Maximum Length: 255

Default Value: false

Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.
DoNotEmailFlag: boolean

Title: Do Not Email

Read Only: true

Maximum Length: 255

Default Value: false

Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.
EmailAddress: string

Title: Primary Email

Read Only: true

Maximum Length: 320

The e-mail address of the contact person for the account.
EmailVerificationDate: string (date)

Title: Email Verification Date

Read Only: true

The date of the verification for the email.
EmailVerificationStatus: string

Title: Email Verification Status

Read Only: true

The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.
FormattedAddress: string

Title: Address

Read Only: true

The formatted address of the contact.
FormattedPhoneNumber: string

Title: Phone Number

Read Only: true

The primary formatted phone number for the contact person.
InfluenceLevelCode: string

Title: Influence Level

Maximum Length: 30

The contact's level of influence in the buying process.
JobTitle: string

Title: Job Title

Maximum Length: 100

The free form text for job title for the contact associated to an account.
JobTitleCode: string

Title: Job Title Code

Maximum Length: 30

The value of the code for the job title of the contact person.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when 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 of the user who last updated the row.
links: array Links

Title: Links

The link relations associated with the resource instance.
PersonBuyingRole: string

Title: Buying Role

Read Only: true

Maximum Length: 30

Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.
PersonJobTitle: string

Title: Contact Job Title

Read Only: true

Maximum Length: 100

The title of the contact's job with deploying organization.
PersonSalesAffinityCode: string

Title: Affinity

Read Only: true

Maximum Length: 30

The contact's affinity for the deploying organization.
PhoneVerificationDate: string (date)

Title: Phone Verification Date

Read Only: true

The date of the verification for phone.
PhoneVerificationStatus: string

Title: Phone Verification Status

Read Only: true

The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.
PreferredContactFlag: boolean

Title: Preferred Contact

Maximum Length: 10

Default Value: false

Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
PreferredContactMethod: string

Title: Preferred Contact Method

Read Only: true

The person's or organization's preferred contact method.
PrimaryCustomerFlag: boolean

Title: Primary Customer

Maximum Length: 10

Default Value: false

Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
ReferenceUseFlag: boolean

Title: Reference

Maximum Length: 1

Default Value: false

Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
RelationshipId: integer (int64)

Title: Relationship Id

Read Only: true

The unique identifier of the relationship associated with account contact record.
RelationshipRecId: integer (int64)

Title: Relationship Record ID

Finds an account contact with the relationship record identifier.
RelationshipSourceSystem: string

Title: Relationship Source System

The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
RelationshipSourceSystemReferenceValue: string

Title: Relationship Source System Reference

The identifier for the relationship with the external source system.
SalesAffinityCode: string

Title: Affinity

Maximum Length: 30

The contact's affinity for the deploying organization.
SalesAffinityComments: string

Title: Affinity Comments

Maximum Length: 2000

The comments describing the contact's affinity for the deploying organization.
SalesBuyingRoleCode: string

Title: Buying Role

Maximum Length: 30

The contact's role in the buying process.
smartActions: array Smart Actions

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Status: string

Maximum Length: 1

Default Value: A

Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceUseFlag":{
            "title":"Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DoCallFlag":{
            "title":"OK to Call",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PersonSalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-smartActions-item-response"
            }
        },
        "AccountSourceSystem":{
            "title":"Account Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"60",
            "type":"string",
            "description":"The free form text used to name the department for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-defined identification number for this contact.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The primary formatted phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailVerificationStatus":{
            "title":"Email Verification Status",
            "type":"string",
            "description":"The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "type":"string",
            "description":"The person's or organization's preferred contact method.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactLastUpdateDate":{
            "title":"Contact Last Update Date",
            "type":"string",
            "description":"The date when the contact record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAffinityComments":{
            "title":"Affinity Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments describing the contact's affinity for the deploying organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipRecId":{
            "title":"Relationship Record ID",
            "type":"integer",
            "description":"Finds an account contact with the relationship record identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonBuyingRole":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "title":"Primary Customer",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact person for the account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PhoneVerificationStatus":{
            "title":"Phone Verification Status",
            "type":"string",
            "description":"The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "EmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The date of the verification for the email.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonJobTitle":{
            "title":"Contact Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of the contact's job with deploying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountSourceSystemReferenceValue":{
            "title":"Account Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title for the contact associated to an account.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ContactFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "DoEmailFlag":{
            "title":"OK to Email",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "DepartmentCode":{
            "title":"Department Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the department code for the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DecisionMakerFlag":{
            "title":"Decision Maker",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountContactId":{
            "title":"Account Contact ID",
            "type":"integer",
            "description":"The unique identifier of the account contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "AccountUniqueName":{
            "title":"Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's role in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship Id",
            "type":"integer",
            "description":"The unique identifier of the relationship associated with account contact record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobTitleCode":{
            "title":"Job Title Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the code for the job title of the contact person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotEmailFlag":{
            "title":"Do Not Email",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "InfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's level of influence in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneVerificationDate":{
            "title":"Phone Verification Date",
            "type":"string",
            "description":"The date of the verification for phone.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

Array of: object accounts-AccountContact-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-smartActions-item-response"
    }
}

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."
        }
    }
}

Nested Schema : accounts-AccountContact-smartActions-item-response

Type: object

Show Source

ActionIntent: string (byte)

Title: Action Intent

JSON object that describes what an action does and what context data can be passed to the action.
ConfirmationMessage: string

Title: Confirmation Message

Maximum Length: 4000

The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
ContentType: string

Title: Content Type

Maximum Length: 50

The media type of the smart action REST operation.
DisplayLabel: string

Title: Action Name

Maximum Length: 256

The display name of the smart action.
Entity: string

Title: Parent Entity

Maximum Length: 150

The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
Href: string

Title: REST Endpoint

Maximum Length: 1024

The relative path of the smart action REST resource. The path can include path parameters.
IncludedInApplication: string

Title: Included in Application

Maximum Length: 512

The client applications that the smart action is associated with.
links: array Links

Title: Links

The link relations associated with the resource instance.
MassActionFlag: boolean

Title: Mass Action

Maximum Length: 1

Boolean type indicating if this action can be mass processed.
Method: string

Title: HTTP Method

Maximum Length: 15

The HTTP method of the smart action REST operation.
ObjectFunctionName: string

Title: Object Function

Maximum Length: 64

The object function associated with the smart action.
PageType: string

Title: Page Type

Maximum Length: 256

The list of pages that this action can be used in.
SmartSuggestFlag: boolean

Title: Smart Suggest

Maximum Length: 1

Indicates whether smart suggest is enabled for the action.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Indicates whether the action is seeded or custom.
UpdateOfAttributes: string

Title: Attributes to Update

Maximum Length: 512

The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
UserActionId: integer (int64)

Title: User Action ID

The unique system assigned identifier of the smart action definition.
UserActionName: string

Title: Action Name

Maximum Length: 256

The unique system assigned smart action name.
UserActionNavigation: array Smart Action User Interface Definitions

Title: Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
UserActionRank: integer (int64)

Title: Priority

The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
UserActionRequestPayload: array Smart Action REST Payload Definitions

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
UserActionURLBinding: array Smart Action REST Path Parameter Definitions

Title: Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"1024",
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

Array of: object accounts-AccountContact-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

Array of: object accounts-AccountContact-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

Array of: object accounts-AccountContact-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : accounts-AccountContact-smartActions-UserActionNavigation-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Default Value: false

The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
UserActionNavAppUsage: string

Title: Application Usage

Maximum Length: 50

The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
UserActionNavBody: string

Title: Navigation Metadata

Maximum Length: 1000

The metadata definition of the smart action user interface endpoint.
UserActionNavId: integer (int64)

Title: Primary Key

The unique system assigned identifier of a smart action user interface definition.
UserActionNavType: string

Title: Navigation Type

Maximum Length: 100

The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "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 : accounts-AccountContact-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

Binding: string

Title: Payload Value Binding Type

Maximum Length: 64

The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
links: array Links

Title: Links

The link relations associated with the resource instance.
MandatoryFlag: boolean

Title: Mandatory

Maximum Length: 1

Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
RequestPayloadId: integer (int64)

The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
RequestPayloadName: string

Title: Request Payload Attribute Name

Maximum Length: 256

The value assigned to the name property of a name-value pair.
SmartSuggestPath: string

Title: Smart Suggest Path

Maximum Length: 2048

The path used for smart suggest.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Default Value: false

The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
Value: string

Title: Request Payload Attribute Value

Maximum Length: 1000

The value assigned to the value property of a name-value pair.
ValueStruct: string

Title: Payload Value Structure

Maximum Length: 20

A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":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 : accounts-AccountContact-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

Binding: string

Title: URL Binding Type

Maximum Length: 64

The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
links: array Links

Title: Links

The link relations associated with the resource instance.
SystemActionFlag: boolean

Title: System Action

Maximum Length: 1

Default Value: false

The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
URLBindingId: integer (int64)

The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
URLBindingName: string

Title: URL Binding Parameter Name

Maximum Length: 256

The value assigned to the name property of a name-value pair.
Value: string

Title: URL Binding Parameter Value

Maximum Length: 1000

The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "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"
    }
}