Jump to

• Request
• Response
• Examples

Get all activity contacts

get

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact

Request

Path Parameters

• ActivityNumber(required): string
  The unique number of the activity. The number can also be generated from an external source.

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:
  
  

  • ActivityContactNumberAltKeyFinder: Finds an activity contact with the alternate key.
    Finder Variables:
    • ActyActivityNumber; string; The alternate key identifier of the activity contact.
    • ContactPartyNumber; string; The alternate key identifier of the activity contact.
  • ActivityContactViewAltKey: Finds an activity contact with the alternate key.
    Finder Variables:
    • ActivityId; integer; The unique identifier of the parent activity.
    • ContactId; integer; The unique identifier of the contact associated with the activity.
  • PrimaryKey: Finds the Activity Contact with the specified primary key identifier.
    Finder Variables:
    • ActivityId; integer; The unique identifier of the Parent activity.
    • ContactId; integer; The unique identifier of the contact associated with the activity.
• 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:
  

  • AccountId; integer; The unique identifier of the account.
  • ActivityContactId; integer; The unique identifier for the surrogate activity contact.
  • ActivityId; integer; The unique identifier of the parent activity for the objective.
  • ActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
  • ActyActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
  • AttendeeFlag; boolean; Indicates if the contact attended the activity. If True, the contact attended.
  • BuyingRole; string; The roles played by the activity contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
  • ConflictId; integer; This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
  • ContactAccount; string; The account associated with the activity contact.
  • ContactAccountId; integer; The unique identifier of the account associated with the activity contact.
  • ContactAccountType; string; The account type for the contact.
  • ContactCustomer; string; The customer contact for the activity.
  • ContactEmail; string; The e-mail address of the activity contact.
  • ContactId; integer; The unique identifier of the contact associated with the activity.
  • ContactJobTitle; string; The job title of the activity contact.
  • ContactLovSwitcher; string; Indicates contact LOV switcher (Not for public usage).
  • ContactPartyNumber; string; The alternate key identifier of the activity contact.
  • ContactPhone; string; The phone number of the activity contact.
  • CorpCurrencyCode; string; The corporate currency used by the activity contact.
  • CreatedBy; string; The user who created the activity contact.
  • CreationDate; string; The date and time when the activity contact was created.
  • CurcyConvRateType; string; The rate of currency conversion for an activity contact.
  • CurrencyCode; string; The currency used for an activity contact.
  • EmailContactPreferenceFlag; string; Indicates the email contact preference.
  • ExternalContactEmail; string; The email address of the external contact.
  • ExternalContactFlag; boolean; Flag indicating that an activity is owned by an external contact.
  • ExternalContactName; string; The name of an external contact.
  • LastUpdateDate; string; The date and time of when the activity contact was last updated.
  • LastUpdateLogin; string; The login details of the user who last updated the activity objective.
  • LastUpdatedBy; string; The unique identifier of the user who last updated the activity contact. This is defaulted by the system.
  • Name; string; The activity contact name.
  • PhoneContactPreferenceFlag; string; Indicates the phone contact preference.
  • PrimaryFormattedAddress; string; The formatted address information of the activity contact.
  • RecurSeriesId; integer; The unique identifier that links instances of a series together.
  • RelationshipId; integer; The unique identifier of the relationship of the contact.
  • UpgSourceObjectId; integer; The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
  • UpgSourceObjectType; string; The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.
  • UserLastUpdateDate; string; The date and time of when the contact was last updated by a user in the disconnect mode.
• 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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : activities-ActivityContact

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/activities-ActivityContact-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object activities-ActivityContact-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/activities-ActivityContact-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 : activities-ActivityContact-item-response

Type: object

Show Source

• AccountId: integer
  The unique identifier of the account.
• ActivityContactId: integer (int64)
  Title: Activity Contact ID

  The unique identifier for the surrogate activity contact.
• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the parent activity for the objective.
• ActivityNumber: string
  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• ActyActivityNumber: string
  Title: Activity Number

  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• Affinity: string
  Read Only: true

  The affinity of an activity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• AttendeeFlag: boolean
  Title: Attendance

  Maximum Length: 1

  Default Value: true

  Indicates if the contact attended the activity. If True, the contact attended.
• BuyingRole: string
  Title: Buying Role

  Read Only: true

  The roles played by the activity contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• ConflictId: integer (int64)
  Default Value: 0

  This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
• ContactAccount: string
  Title: Account

  The account associated with the activity contact.
• ContactAccountId: integer
  The unique identifier of the account associated with the activity contact.
• ContactAccountType: string
  The account type for the contact.
• ContactCustomer: string
  Title: Contact Customer

  The customer contact for the activity.
• ContactEmail: string
  Title: Email

  The e-mail address of the activity contact.
• ContactId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the activity.
• ContactJobTitle: string
  Title: Title

  The job title of the activity contact.
• ContactLovSwitcher: string
  Indicates contact LOV switcher (Not for public usage).
• ContactName: string
  Title: Name

  The name of the contact for the activity.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the activity contact.
• ContactPhone: string
  Title: Phone

  The phone number of the activity contact.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency used by the activity contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the activity contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the activity contact was created.
• CurcyConvRateType: string
  Maximum Length: 30

  The rate of currency conversion for an activity contact.
• CurrencyCode: string
  Maximum Length: 15

  The currency used for an activity contact.
• DoNotCallFlag: boolean
  Read Only: true

  Indicates whether the contact should be called. The default value is false.
• DoNotContactFlag: boolean
  Read Only: true

  Indicates whether the activity contact should be contacted. The default value is false.
• DoNotEmailFlag: boolean
  Read Only: true

  Indicates whether the contact should be emailed. The default value is false.
• EmailContactPreferenceFlag: string
  Indicates the email contact preference.
• ExternalContactEmail: string
  Title: External Contact Email

  Maximum Length: 320

  The email address of the external contact.
• ExternalContactFlag: boolean
  Title: External Contact

  Maximum Length: 1

  Default Value: false

  Flag indicating that an activity is owned by an external contact.
• ExternalContactName: string
  Title: External Contact Name

  Maximum Length: 360

  The name of an external contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time of when the activity contact was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The unique identifier of the user who last updated the activity contact. This is defaulted by the system.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the activity objective.
• links: array Links
  Title: Links

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

  Read Only: true

  The activity contact name.
• PhoneContactPreferenceFlag: string
  Indicates the phone contact preference.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates if this contact is the primary contact.
• PrimaryFormattedAddress: string
  The formatted address information of the activity contact.
• RecurSeriesId: integer (int64)
  The unique identifier that links instances of a series together.
• RelationshipId: integer (int64)
  Title: Relationship ID

  The unique identifier of the relationship of the contact.
• UpgSourceObjectId: integer (int64)
  Read Only: true

  The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
• UpgSourceObjectType: string
  Read Only: true

  Maximum Length: 30

  The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date and time of when the contact was last updated by a user in the disconnect mode.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the activity contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if this contact is the primary contact.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "nullable":true,
            "x-queryable":true
        },
        "UpgSourceObjectId":{
            "type":"integer",
            "description":"The primary key value of the record in the source table that is upgraded to Rel9 Activity record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactLovSwitcher":{
            "type":"string",
            "description":"Indicates contact LOV switcher (Not for public usage).",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the parent activity for the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactAccountId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFormattedAddress":{
            "type":"string",
            "description":"The formatted address information of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactEmail":{
            "title":"External Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAccountType":{
            "type":"string",
            "description":"The account type for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "BuyingRole":{
            "title":"Buying Role",
            "type":"string",
            "description":"The roles played by the activity contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActyActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time of when the contact was last updated by a user in the disconnect mode.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The rate of currency conversion for an activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneContactPreferenceFlag":{
            "type":"string",
            "description":"Indicates the phone contact preference.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "type":"string",
            "description":"The activity contact name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency used for an activity contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPhone":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Title",
            "type":"string",
            "description":"The job title of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactCustomer":{
            "title":"Contact Customer",
            "type":"string",
            "description":"The customer contact for the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityContactId":{
            "title":"Activity Contact ID",
            "type":"integer",
            "description":"The unique identifier for the surrogate activity contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "type":"boolean",
            "description":"Indicates whether the contact should be called. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttendeeFlag":{
            "title":"Attendance",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the contact attended the activity. If True, the contact attended.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency used by the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the user who last updated the activity contact. This is defaulted by the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailContactPreferenceFlag":{
            "type":"string",
            "description":"Indicates the email contact preference.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the activity contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalContactName":{
            "title":"External Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the activity contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity contact should be contacted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpgSourceObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DoNotEmailFlag":{
            "type":"boolean",
            "description":"Indicates whether the contact should be emailed. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Affinity":{
            "type":"string",
            "description":"The affinity of an activity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the contact for the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ContactAccount":{
            "title":"Account",
            "type":"string",
            "description":"The account associated with the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactFlag":{
            "title":"External Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag indicating that an activity is owned by an external contact.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of when the activity contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the activity objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "type":"integer",
            "description":"The unique identifier that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact

Example of Response Body

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

{
"items": [1]
0:  {
"ActivityId": 300100091331368
"ContactId": 300100007475829
"RelationshipId": null
"ActivityNumber": null
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-08-24T00:31:27-07:00"
"LastUpdateDate": "2016-08-24T00:31:27-07:00"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"LastUpdatedBy": "SALES_ADMIN"
"ObjectVersionNumber": 1
"ConflictId": 0
"UserLastUpdateDate": null
"PrimaryContactFlag": true
"ContactName": "Mike Rabatin"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
"ContactEmail": null
"ContactPhone": "[phone]"
"ContactJobTitle": null
"EmailContactPreferenceFlag": null
"PhoneContactPreferenceFlag": null
"ContactCustomer": null
"ContactAccount": null
"AccountId": null
"ContactLovSwitcher": "LOV_ContactName"
"ActivityContactId": 300100091331387
"DoNotContactFlag": false
"DoNotCallFlag": false
"DoNotEmailFlag": false
"ContactAccountId": null
"ContactAccountType": null
"UpgSourceObjectId": null
"UpgSourceObjectType": null
"RecurSeriesId": null
"AttendeeFlag": true
"Affinity": ""
"BuyingRole": ""
"PrimaryFormattedAddress": null
"ContactPartyNumber": "CDRM_575"
"links": [6]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75"
"name": "ActivityContact"
"kind": "item"
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}-
}-
1:  {
"rel": "canonical"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75"
"name": "ActivityContact"
"kind": "item"
}-
2:  {
"rel": "parent"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275"
"name": "activities"
"kind": "item"
}-
3:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75/lov/ContactListVA"
"name": "ContactListVA"
"kind": "collection"
}-
4:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75/lov/YesNoAttendeeFlagLookup"
"name": "YesNoAttendeeFlagLookup"
"kind": "collection"
}-
5:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75/lov/RatedCurrenciesVA"
"name": "RatedCurrenciesVA"
"kind": "collection"
}-
-
}-
-
"count": 1
"hasMore": false
"limit": 25
"offset": 0
"links": [1]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact"
"name": "ActivityContact"
"kind": "collection"
}-
-
}

Back to Top