Get a campaign member
get
/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/MktCampaignMembers/{MktCampaignMembersUniqID}
Request
Path Parameters
-
CampaignNumber(required): string
The alternate key identifier of the campaign.
-
MktCampaignMembersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Campaign Members resource and used to uniquely identify an instance of Campaign Members. The client should not generate the hash key value. Instead, the client should query on the Campaign Members collection resource in order to navigate to a specific instance of Campaign Members to get the hash key.
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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-MktCampaignMembers-item-response
Type:
Show Source
object
-
Active: string
Title:
Is Active
Read Only:true
Maximum Length:1
Default Value:Y
Indicates whether the campaign member is active or not. -
CampaignCampaignName: string
Title:
Name
Read Only:true
Maximum Length:100
The name of the campaign to which the campaign member belongs to. -
CampaignCampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign member belongs to. -
CampaignEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when marketing integration campaign ends. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign member. -
CampaignMemberId: integer
(int64)
Title:
Campaign Member ID
The unique identifier of the campaign. -
CampaignMemberNumber: string
Title:
Campaign Member Number
Maximum Length:30
The alternate key identifier of the campaign member. -
CampaignStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when marketing integration campaign starts. -
CampaignStatus: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_DRAFT
The status of marketing integration campaign. -
CampaignType: string
Title:
Type
Read Only:true
Maximum Length:30
The type of marketing integration campaign. -
ContactEmail: string
Title:
Contact Email
Read Only:true
Maximum Length:320
The email address of the contact associated with the campaign member. -
ContactId: integer
(int64)
Title:
Contact ID
The unique identifier of the party associated with the campaign member. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The name of the contact party associated with the campaign member. -
ContactPartyNumber: string
Title:
Contact Number
Maximum Length:30
The unique alternate identifier of the contact associated with the campaign member. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign member. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:60
Default Value:ORA_WS
The module through which the campaign member can be created. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign member was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code indicating the currency associated with the campaign member, such as USD or GBP. -
DeleteFlag: boolean
Title:
Can Be Deleted
Read Only:true
Indicates whether the campaign member can be deleted by the logged in user. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the campaign member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the campaign member was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the campaign member. -
LeadAccountName: string
Title:
Lead Account
Read Only:true
Maximum Length:360
The account name of the lead associated with the campaign member. -
LeadEmail: string
Title:
Lead Email
Read Only:true
Maximum Length:320
The email address of the lead associated with the campaign member. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign member. -
LeadLeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the campaign member. -
LeadLeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign member. -
LeadOwnerName: string
Title:
Lead Owner
Read Only:true
Maximum Length:360
The owner name of the lead associated with the campaign member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberResponseDate: string
(date-time)
Title:
Response Date
The date when the response is received for the campaign member. -
MemberStatus: string
Title:
Member Status
Maximum Length:30
Default Value:ORA_SENT
The status of the campaign member. -
MemberStatusLookupMeaning: string
Title:
Member Status
Read Only:true
Maximum Length:80
The display label for the status of the campaign member. -
SourceSystemCampMemberId: string
Title:
Source System Campaign Member ID
Maximum Length:100
The unique identifier of the campaign member in the source system. -
UpdateFlag: boolean
Title:
Can Be Updated
Read Only:true
Indicates whether the campaign member can be updated by the logged in user.
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
- CampaignStatusVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: CampaignStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CampaignTypeVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPAIGN_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: CampaignType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CreatedByModuleVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMP_CREATED_BY_MOD
The following properties are defined on the LOV link relation:- Source Attribute: CreatedByModule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CurrencyCodeVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: Name
- MemberStatusVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_MKT_CAMPMEMBER_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: MemberStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get a campaign marketing member 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/campaigns/{CampaignNumber}/child/MktCampaignMembers/{MktCampaignMembersUniqID}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "CampaignId": 300100182332579, "CampaignMemberId": 300100182332580, "CampaignMemberNumber": "CDRM_7", "ContactId": null, "CreatedBy": "SALES_ADMIN", "CreatedByModule": "ORA_WS", "CreationDate": "2019-09-06T08:48:00+00:00", "CurrencyCode": "USD", "EmailAddress": null, "LastUpdateDate": "2019-09-06T08:48:00.068+00:00", "LastUpdateLogin": "910A4E87FF1C9F8BE053A15AF00A8B53", "LastUpdatedBy": "SALES_ADMIN", "LeadId": 300100182222847, "MemberStatus": "ORA_RESPONDED", "SourceSystemCampMemberId": null, "ContactPartyName": null, "CampaignCampaignName": "BIQA_ELQ_CAMPAIGN7", "CampaignCampaignNumber": "CDRM_7", "LeadLeadName": "BIQA_ELQ_SA_LEAD7", "UpdateFlag": true, "DeleteFlag": true, "MemberStatusLookupMeaning": "Responded", "MemberResponseDate": "2019-09-06T00:00:00+00:00", "ContactPartyNumber": null, "LeadLeadNumber": "CDRM_81806", "LeadAccountName": null, "LeadOwnerName": "Gabrielle Lee", "LeadEmail": null, "ContactEmail": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_7/child/MktCampaignMembers/300100182332580", "name": "MktCampaignMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_7/child/MktCampaignMembers/300100182332580", "name": "MktCampaignMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_7", "name": "campaigns", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_7/child/MktCampaignMembers/300100182332580/lov/CurrencyCodeVA", "name": "CurrencyCodeVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_7/child/MktCampaignMembers/300100182332580/lov/MemberStatusVA", "name": "MemberStatusVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_7/child/MktCampaignMembers/300100182332580/lov/CreatedByModuleVA", "name": "CreatedByModuleVA", "kind": "collection" } ] }