Get a campaign account
get
/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts/{CampaignAccountsUniqID}
Request
Path Parameters
-
CampaignAccountsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Campaign Accounts resource and used to uniquely identify an instance of Campaign Accounts. The client should not generate the hash key value. Instead, the client should query on the Campaign Accounts collection resource in order to navigate to a specific instance of Campaign Accounts to get the hash key.
-
CampaignNumber(required): string
The alternate key identifier of the campaign.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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 : campaigns-CampaignAccounts-item-response
Type:
Show Source
object
-
AccountCountry: string
Title:
Country
Read Only:true
The country of the account. -
AccountId: integer
(int64)
Title:
Campaign Account Party ID
The unique identifier of the account associated with the campaign account. -
AccountIndustryClassCode: string
Title:
Primary Industry
Read Only:true
The primary industry class code for the account. -
AccountName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the account party associated with the campaign account. -
AccountPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The unique alternate identifier of the account associated with the campaign account. -
AccountState: string
Title:
State
Read Only:true
Maximum Length:60
The state of the account. -
AccountTotalEmployees: number
Title:
Company Size
Read Only:true
The total number of employees for the account. -
CampaignAccountId: integer
(int64)
Title:
Campaign Account ID
The unique identifier of the campaign account. -
CampaignAccountNumber: string
Title:
Campaign Account Number
Maximum Length:30
The alternate key identifier of the campaign account. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign account belongs to. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign accounts. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign account was created. -
ErrorDescription: string
Title:
Error Description
Maximum Length:2000
This contains the error message generated during lead generation of this account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign account was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign account. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign account. -
LeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the campaign account. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QueryCriteriaType: string
Title:
Query Criteria Type
Maximum Length:10
Default Value:MANUAL
This indicates whether the account is added by query builder or manually.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- QueryCriteriaTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_ACNTS_ADD_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: QueryCriteriaType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: