Get all recruiting campaign details
get
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails
Request
Query Parameters
-
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- FindByCampaignCode Finds campaign details using unique code
Finder Variables- CampaignCode; string; Finds campaign details using campaign code
- PrimaryKey Finds campaign details using an ID
Finder Variables- CampaignId; integer; Finds campaign details using campaign ID
- FindByCampaignCode Finds campaign details using unique code
-
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:- AudiencePopulatedFlag; boolean; Indicates that the audience field is populated.
- AudienceSavedSearchId; integer; ID assigned to the saved audience search.
- CampaignCode; string; Code assigned to each campaign.
- CampaignId; integer; ID assigned to the campaign.
- CampaignLanguageCode; string; Code assigned to each campaign language.
- CampaignName; string; Name assigned to each campaign.
- CampaignStatusCode; string; Code assigned to the status of the campaign.
- CampaignTypeCode; string; Code assigned to the type of the campaign.
- JourneyCommunicationGoal; string; Communication goal of the journey campaign.
- JourneyId; integer; ID assigned to each journey.
- PurposeCode; string; Code assigned to the purpose of the campaign.
- RequisitionSavedSearchId; integer; ID assigned to the saved requisition search.
- SearchRequisitionsFlag; boolean; Indicates that the search is for a requisition.
- TargetGoalValue; integer; Target value of the goal.
-
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 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 : recruitingCampaignDetails
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-item-response
Type:
Show Source
object
-
AudiencePopulatedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the audience field is populated. -
AudienceSavedSearchId: integer
(int64)
Read Only:
true
ID assigned to the saved audience search. -
campaignAssets: array
Campaign Assets
Title:
Campaign Assets
The campaignAssets resource is a child of recruitingCampaignDetails. It includes all the assets of the campaign. -
campaignBOAssociations: array
Campaign Business Object Association
Title:
Campaign Business Object Association
The campaignBOAssociations resource is a child of recruitingCampaignDetails. It includes all the business object associations of the campaign. -
CampaignCode: string
Read Only:
true
Maximum Length:30
Code assigned to each campaign. -
CampaignDescription: string
(byte)
Read Only:
true
Description of the campaign. -
campaignGoalResponses: array
Campaign Goal Responses
Title:
Campaign Goal Responses
The campaignGoalResponses resource is a child of recruitingCampaignDetails. It includes all the goal responses of the campaign. -
CampaignId: integer
(int64)
Read Only:
true
ID assigned to the campaign. -
CampaignLanguageCode: string
Read Only:
true
Maximum Length:30
Code assigned to each campaign language. -
CampaignName: string
Read Only:
true
Maximum Length:240
Name assigned to each campaign. -
CampaignStatusCode: string
Read Only:
true
Maximum Length:30
Code assigned to the status of the campaign. -
CampaignTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to the type of the campaign. -
JourneyCommunicationGoal: string
Read Only:
true
Maximum Length:30
Communication goal of the journey campaign. -
JourneyId: integer
(int64)
Read Only:
true
ID assigned to each journey. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PurposeCode: string
Read Only:
true
Maximum Length:30
Code assigned to the purpose of the campaign. -
RequisitionSavedSearchId: integer
(int64)
Read Only:
true
ID assigned to the saved requisition search. -
SearchRequisitionsFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the search is for a requisition. -
TargetGoalValue: integer
(int64)
Read Only:
true
Target value of the goal.
Nested Schema : Campaign Assets
Type:
array
Title:
Campaign Assets
The campaignAssets resource is a child of recruitingCampaignDetails. It includes all the assets of the campaign.
Show Source
Nested Schema : Campaign Business Object Association
Type:
array
Title:
Campaign Business Object Association
The campaignBOAssociations resource is a child of recruitingCampaignDetails. It includes all the business object associations of the campaign.
Show Source
Nested Schema : Campaign Goal Responses
Type:
array
Title:
Campaign Goal Responses
The campaignGoalResponses resource is a child of recruitingCampaignDetails. It includes all the goal responses of the campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-campaignAssets-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Read Only:
true
ID assigned to each asset for campaign asset. -
AssetName: string
Maximum Length:
240
Name assigned to each asset. -
AssetStatusCode: string
Maximum Length:
30
Code assigned to each status of asset. -
AssetTypeCode: string
Maximum Length:
30
Code assigned to each type of asset. -
AudienceDerivedFlag: boolean
Maximum Length:
1
Indicates that the campaign is for derived audience. -
CampaignAssetChannels: array
Campaign Asset Channels
Title:
Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign. -
campaignAssetSegments: array
Campaign Asset Segments
Title:
Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign. -
DisplayRank: integer
Rank of the campaign asset.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDesignId: integer
(int64)
ID assigned to each message design.
-
ParentAssetId: integer
(int64)
ID assigned to the parent asset.
-
ScheduledDate: string
(date-time)
Date when the campaign is scheduled.
-
SortOrderDate: string
(date-time)
Date of sorting the order.
Nested Schema : Campaign Asset Channels
Type:
array
Title:
Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
Show Source
Nested Schema : Campaign Asset Segments
Type:
array
Title:
Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Read Only:
true
ID assigned to each asset for campaign asset channel. -
ChannelId: integer
Read Only:
true
ID assigned to each channel. -
ChannelPostURL: string
Read Only:
true
Maximum Length:1000
URL of the channel where campaign is posted. -
ChannelTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each type of channel. -
ChannelTypeMeaning: string
Read Only:
true
Maximum Length:80
Description of each channel type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-response
Type:
Show Source
object
-
AssetSegmentId: integer
(int64)
Read Only:
true
ID assigned to each asset segment. -
CriteriaTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each criteria type. -
GoalResponseId: integer
(int64)
Read Only:
true
ID assigned to each response of a goal for the campaign asset segment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseLabel: string
Read Only:
true
Maximum Length:240
Label assigned to each response for the campaign asset segment. -
SegmentName: string
Read Only:
true
Name of each segment. -
SegmentTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each segment type. -
SegmentTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of each segment type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-campaignBOAssociations-item-response
Type:
Show Source
object
-
BoAssignedAfterDate: string
(date-time)
Read Only:
true
Description for the attribute which stores the assigned after date. -
BoGoal: string
Read Only:
true
Maximum Length:30
Goal of the business object. Valid values are ORA_ASSIGNED and ORA_UNASSIGNED. -
BoType: string
Read Only:
true
Maximum Length:30
Description for the attribute which stores the business object type. For example, Learn and Journey. -
campaignBOAssociatedItems: array
Campaign Business Object Associated Items
Title:
Campaign Business Object Associated Items
The campaignBOAssociatedItems resource is a child of campaignBOAssociations. It includes all the associated business object items. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Campaign Business Object Associated Items
Type:
array
Title:
Campaign Business Object Associated Items
The campaignBOAssociatedItems resource is a child of campaignBOAssociations. It includes all the associated business object items.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-campaignBOAssociations-campaignBOAssociatedItems-item-response
Type:
Show Source
object
-
BoId: integer
(int64)
Read Only:
true
Unique identifier of business objects, for example, Learning Item ID and Journey ID. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-campaignGoalResponses-item-response
Type:
Show Source
object
-
DestinationURL: string
Read Only:
true
Maximum Length:1000
Destination URL used by the campaign. -
GoalId: integer
(int64)
Read Only:
true
ID assigned to each goal. -
GoalResponseId: integer
(int64)
Read Only:
true
ID assigned to each response of a goal. -
IncludeInTargetFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the item is included in the campaign. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseLabel: string
Read Only:
true
Maximum Length:240
Label assigned to each item to mark it as a response. -
UseDefaultURLFlag: boolean
Read Only:
true
Maximum Length:1
Indicates the default URL.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source