1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Campaign Members

Get all campaign members

get

/crmRestApi/resources/11.13.18.05/campaignMembers

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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:

    • CampaignMemberNumAltKey: Finds a campaign members with the specified alternate key.
      Finder Variables:
      • CampaignMemberNumber; string; The alternate key identifier of the campaign member.
    • PrimaryKey: Finds a campaign members with the specified primary key.
      Finder Variables:
      • CampaignMemberId; integer; The unique identifier of the campaign member.
  • 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:
    • Active; string; Indicates whether the campaign member is active or not.
    • CampaignCampaignName; string; The name of the campaign to which the campaign member belongs to.
    • CampaignCampaignNumber; string; The unique identifier of the campaign to which the campaign member belongs to.
    • CampaignEndDate; string; The date when marketing integration campaign ends.
    • CampaignId; integer; The unique identifier of the campaign.
    • CampaignMemberId; integer; The unique identifier of the campaign member.
    • CampaignMemberNumber; string; The alternate key identifier of the campaign member.
    • CampaignStartDate; string; The date when marketing integration campaign starts.
    • CampaignStatus; string; The status of marketing integration campaign.
    • CampaignType; string; The type of marketing integration campaign.
    • ContactEmail; string; The email address of the contact associated with the campaign member.
    • ContactId; integer; The unique identifier of the party associated with the campaign member.
    • ContactPartyName; string; The name of the contact party associated with the campaign member.
    • ContactPartyNumber; string; The unique alternate identifier of the contact associated with the campaign member.
    • CreatedByModule; string; The module through which the campaign member can be created.
    • CreationDate; string; The date when the campaign member was created.
    • EmailAddress; string; The email address of the campaign member.
    • LastUpdateDate; string; The date when the campaign member was last updated.
    • LeadAccountName; string; The account name of the lead associated with the campaign member.
    • LeadEmail; string; The email address of the lead associated with the campaign member.
    • LeadId; integer; The unique identifier of the lead associated with the campaign member.
    • LeadLeadName; string; The name of the lead associated with the campaign member.
    • LeadLeadNumber; string; The unique alternate identifier of the lead associated with the campaign member.
    • LeadOwnerName; string; The owner name of the lead associated with the campaign member.
    • MemberResponseDate; string; The date when the response is received for the campaign member.
    • MemberStatus; string; The status of the campaign member.
    • MemberStatusLookupMeaning; string; The display label for the status of the campaign member.
    • SourceSystemCampMemberId; string; The unique identifier of the campaign member in the source system.
  • 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
  • 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.
  • 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 : campaignMembers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : campaignMembers-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all campaign members 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/campaignMembers

Example of Response Body

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

{
    "items": [
        {
            "CampaignId": 300100182332573,
            "CampaignMemberId": 300100182466478,
            "CampaignMemberNumber": "CDRM_1",
            "ContactId": 300100182222633,
            "CreatedBy": "SALES_ADMIN",
            "CreatedByModule": "ORA_WS",
            "CreationDate": "2019-09-06T08:07:42+00:00",
            "CurrencyCode": "USD",
            "EmailAddress": null,
            "LastUpdateDate": "2019-09-06T08:07:43.534+00:00",
            "LastUpdateLogin": "915B97A3570215E0E053A15AF00AEA7B",
            "LastUpdatedBy": "SALES_ADMIN",
            "LeadId": 300100182222714,
            "MemberStatus": "ORA_RESPONDED",
            "SourceSystemCampMemberId": null,
            "ContactPartyName": "BIQA_ELQ_SA_CONTACT1 LAST_NAME1",
            "CampaignCampaignName": "BIQA_ELQ_CAMPAIGN1",
            "CampaignCampaignNumber": "CDRM_1",
            "LeadLeadName": "BIQA_ELQ_SA_LEAD1",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "MemberStatusLookupMeaning": "Responded",
            "MemberResponseDate": "2019-09-06T00:00:00+00:00",
            "ContactPartyNumber": "CDRM_880751",
            "LeadLeadNumber": "CDRM_81800",
            "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/campaignMembers/CDRM_1",
                    "name": "campaignMembers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1",
                    "name": "campaignMembers",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1/lov/CurrencyCodeVA",
                    "name": "CurrencyCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1/lov/MemberStatusVA",
                    "name": "MemberStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers/CDRM_1/lov/CreatedByModuleVA",
                    "name": "CreatedByModuleVA",
                    "kind": "collection"
                }
            ]
        },
  .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaignMembers",
            "name": "campaignMembers",
            "kind": "collection"
        }
    ]
}
Back to Top