1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Organization Contacts

Get all account contacts

get

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

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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:
        • ForFinancialParties :Find the contacts of linked financial parties 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.
        • 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.
        • 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
        • 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.
        • The resource item payload will be filtered in order to contain only data (no links section, for example).
        • 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
        • 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.
        • 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
        • 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".
        • 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.

        Back to Top

        Response

        Supported Media Types

        Default Response

        The following table describes the default response for this task.
        Headers
        • 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".
        • 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 : accounts-AccountContact
        Type: object
        Show Source
        Nested Schema : Items
        Type: array
        Title: Items
        The items in the collection.
        Show Source
        Nested Schema : accounts-AccountContact-item-response
        Type: object
        Show Source
        • Title: Account Contact ID
          Read Only: true
          The unique identifier of the account contact.
        • Title: Account
          Read Only: true
          Maximum Length: 360
          The name of the account.
        • 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.
        • 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.
        • 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.
        • 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.
        • Title: Account
          Read Only: true
          Maximum Length: 900
          The unique name of the account.
        • Title: Comments
          Maximum Length: 2000
          The comments of the user.
        • Title: First Name
          Read Only: true
          Maximum Length: 150
          The first name of the contact record.
        • Title: Last Name
          Read Only: true
          Maximum Length: 150
          The last name of the contact record.
        • Title: Contact Last Update Date
          Read Only: true
          The date when the contact record was last updated.
        • Title: Name
          Read Only: true
          Maximum Length: 360
          The name of the contact.
        • Title: Contact Number
          Maximum Length: 30
          The user-defined identification number for this contact.
        • 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.
        • 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.
        • 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.
        • 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.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          The user who created the row.
        • 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.
        • Title: Creation Date
          Read Only: true
          The date and time when the row was created.
        • 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.
        • Title: Department
          Maximum Length: 60
          The free form text used to name the department for the contact.
        • Title: Department Code
          Maximum Length: 30
          The value of the department code for the contact.
        • 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.
        • 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.
        • 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.
        • 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.
        • Title: Primary Email
          Read Only: true
          Maximum Length: 320
          The e-mail address of the contact person for the account.
        • Title: Email Verification Date
          Read Only: true
          The date of the verification for the email.
        • 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.
        • Title: Address
          Read Only: true
          The formatted address of the contact.
        • Title: Phone Number
          Read Only: true
          The primary formatted phone number for the contact person.
        • Title: Influence Level
          Maximum Length: 30
          The contact's level of influence in the buying process.
        • Title: Job Title
          Maximum Length: 100
          The free form text for job title for the contact associated to an account.
        • Title: Job Title Code
          Maximum Length: 30
          The value of the code for the job title of the contact person.
        • Title: Last Updated Date
          Read Only: true
          The date and time when the record was last updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          The user who last updated the record.
        • Title: Last Update Login
          Read Only: true
          Maximum Length: 32
          The login of the user who last updated the row.
        • Links
        • 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.
        • Title: Contact Job Title
          Read Only: true
          Maximum Length: 100
          The title of the contact's job with deploying organization.
        • Title: Affinity
          Read Only: true
          Maximum Length: 30
          The contact's affinity for the deploying organization.
        • Title: Phone Verification Date
          Read Only: true
          The date of the verification for phone.
        • 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.
        • 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.
        • Title: Preferred Contact Method
          Read Only: true
          The person's or organization's preferred contact method.
        • 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.
        • 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.
        • Title: Relationship Id
          Read Only: true
          The unique identifier of the relationship associated with account contact record.
        • Title: Relationship Record ID
          Finds an account contact with the relationship record identifier.
        • 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.
        • Title: Relationship Source System Reference
          The identifier for the relationship with the external source system.
        • Title: Affinity
          Maximum Length: 30
          The contact's affinity for the deploying organization.
        • Title: Affinity Comments
          Maximum Length: 2000
          The comments describing the contact's affinity for the deploying organization.
        • Title: Buying Role
          Maximum Length: 30
          The contact's role in the buying process.
        • 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.
        • 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.
        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
        Nested Schema : accounts-AccountContact-smartActions-item-response
        Type: object
        Show Source
        • Title: Action Intent
          JSON object that describes what an action does and what context data can be passed to the action.
        • Title: Confirmation Message
          Maximum Length: 4000
          The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
        • Title: Content Type
          Maximum Length: 50
          The media type of the smart action REST operation.
        • Title: Action Name
          Maximum Length: 256
          The display name of the smart action.
        • 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.
        • Title: REST Endpoint
          Maximum Length: 1024
          The relative path of the smart action REST resource. The path can include path parameters.
        • Title: Included in Application
          Maximum Length: 512
          The client applications that the smart action is associated with.
        • Links
        • Title: Mass Action
          Maximum Length: 1
          Boolean type indicating if this action can be mass processed.
        • Title: HTTP Method
          Maximum Length: 15
          The HTTP method of the smart action REST operation.
        • Title: Object Function
          Maximum Length: 64
          The object function associated with the smart action.
        • Title: Page Type
          Maximum Length: 256
          The list of pages that this action can be used in.
        • Title: Smart Suggest
          Maximum Length: 1
          Indicates whether smart suggest is enabled for the action.
        • Title: System Action
          Maximum Length: 1
          Indicates whether the action is seeded or custom.
        • 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.
        • Title: User Action ID
          The unique system assigned identifier of the smart action definition.
        • Title: Action Name
          Maximum Length: 256
          The unique system assigned smart action name.
        • 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.
        • Title: Priority
          The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
        • 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.
        • 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.
        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
        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
        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
        Nested Schema : accounts-AccountContact-smartActions-UserActionNavigation-item-response
        Type: object
        Show Source
        • Links
        • 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.
        • Title: Application Usage
          Maximum Length: 50
          The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
        • Title: Navigation Metadata
          Maximum Length: 1000
          The metadata definition of the smart action user interface endpoint.
        • Title: Primary Key
          The unique system assigned identifier of a smart action user interface definition.
        • Title: Navigation Type
          Maximum Length: 100
          The text value used by applications to determine which user interface to launch.
        Nested Schema : accounts-AccountContact-smartActions-UserActionRequestPayload-item-response
        Type: object
        Show Source
        • 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
        • 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.
        • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
        • Title: Request Payload Attribute Name
          Maximum Length: 256
          The value assigned to the name property of a name-value pair.
        • Title: Smart Suggest Path
          Maximum Length: 2048
          The path used for smart suggest.
        • 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.
        • Title: Request Payload Attribute Value
          Maximum Length: 1000
          The value assigned to the value property of a name-value pair.
        • 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.
        Nested Schema : accounts-AccountContact-smartActions-UserActionURLBinding-item-response
        Type: object
        Show Source
        • 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
        • 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.
        • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
        • Title: URL Binding Parameter Name
          Maximum Length: 256
          The value assigned to the name property of a name-value pair.
        • Title: URL Binding Parameter Value
          Maximum Length: 1000
          The value assigned to the value property of a name-value pair.
        Back to Top

        Examples

        The following example shows how to get all account contacts by submitting a get request on the REST resource using cURL.

        cURL Command

        curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact

        Example of Response Body

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

        {
    "items": [
        {
            "AccountContactId": 100000016105055,
            "RelationshipRecId": 100000016105043,
            "RelationshipId": 100000016105044,
            "RelationshipSourceSystem": null,
            "RelationshipSourceSystemReferenceValue": null,
            "ContactPartyId": 100000016105039,
            "ContactPartyNumber": "100000016105038",
            "ContactSourceSystem": null,
            "ContactSourceSystemReferenceValue": null,
            "ContactName": "A Lewis",
            "ContactFirstName": "A",
            "ContactLastName": "Lewis",
            "EmailAddress": "sendmail-test-discard@oracle.com",
            "FormattedPhoneNumber": "3902582559",
            "FormattedAddress": null,
            "PreferredContactMethod": null,
            "ReferenceUseFlag": false,
            "DecisionMakerFlag": false,
            "Comments": null,
            "ContactNumber": "100000016105054",
            "Department": null,
            "DepartmentCode": "HUMAN RESOURCES",
            "JobTitle": "Director, Planning and Budgeting",
            "JobTitleCode": null,
            "SalesAffinityCode": null,
            "SalesAffinityComments": null,
            "SalesBuyingRoleCode": null,
            "InfluenceLevelCode": "NONE",
            "PreferredContactFlag": false,
            "PrimaryCustomerFlag": false,
            "Status": "A",
            "CreatedByModule": "ZCM",
            "LastUpdateDate": "2010-01-29T07:24:39.338+00:00",
            "LastUpdateLogin": "7E4EEA006E9FCA20E04044987CF027F2",
            "LastUpdatedBy": "OPERATIONS",
            "CreatedBy": "OPERATIONS",
            "CreationDate": "2010-01-29T07:23:41.915+00:00",
            "ContactLastUpdateDate": "2013-12-23T03:06:26.672+00:00",
            "AccountPartyId": 100000015957398,
            "AccountPartyNumber": "100000015957397",
            "AccountSourceSystem": null,
            "AccountSourceSystemReferenceValue": null,
            "DoNotCallFlag": false,
            "DoNotEmailFlag": false,
            "PhoneVerificationStatus": null,
            "PhoneVerificationDate": null,
            "EmailVerificationStatus": null,
            "EmailVerificationDate": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055",
                    "name": "AccountContact",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055",
                    "name": "AccountContact",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397",
                    "name": "accounts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055/lov/JobTitleCodeVA",
                    "name": "JobTitleCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055/lov/SalesAffinityCodeLookupVA",
                    "name": "SalesAffinityCodeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055/lov/SalesBuyingRoleCodeLookupVA",
                    "name": "SalesBuyingRoleCodeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055/lov/InfluenceLevelCodeLookupVA",
                    "name": "InfluenceLevelCodeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055/lov/DepartmentCodeVA",
                    "name": "DepartmentCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact/100000016105055/lov/PreferredContactMethodVA",
                    "name": "PreferredContactMethodVA",
                    "kind": "collection"
                }
            ]
        },
        .....
    ],
    "count": 4,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/AccountContact",
            "name": "AccountContact",
            "kind": "collection"
        }
    ]
}
        Back to Top