Get details of all the certifications
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems
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- PrimaryKey Finds candidate certification items by a unique ID
Finder Variables- CertificationId; integer; Finds candidate certification items by a unique ID and the certification ID
- findBySectionId Finds candidate certification items by the section ID
Finder Variables- FlowVersionId; integer; Finds candIDate certification items by the section ID and the flow version ID
- SectionId; integer; Finds candidate certification items by the section ID and the SectionId; integer; variable
- PrimaryKey Finds candidate certification items by a unique ID
-
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:- ActualCompletionDate; string; Actual completion date of the certifications done by the candidate.
- CertificationId; integer; Certification ID of the certification.
- CertificationName; string; Name of the certification.
- CertificationNumber; string; Number assigned to the certification.
- CertificationURL; string; URL of the certification.
- CompletedAmount; integer; Completed amount of the certification.
- CompletedTrainingUnits; string; Number of training units completed for the certification.
- ContentItemId; integer; Unique identifier assigned to each content item.
- CountryCode; string; Country Code specified in the certification
- CountryId; integer; Country ID specified in the certification.
- EducationalEstablishment; string; Educational establishment that issued the certification.
- EducationalEstablishmentId; integer; Unique identifier assigned to the educational establishment.
- ExpirationDate; string; Expiration date of the certification.
- FlowVersionId; integer; This gives the Service Metadata
- IssueDate; string; Date on which the certification was issued
- IssuedBy; string; Name of the authority that issued the certification.
- LastRenewalDate; string; Last date for renewal of the certification.
- OriginalIssueYear; integer; Year when the certification was issued.
- RenewalDate; string; Date on which the certification was renewed.
- RenewalInprogressFlag; boolean; Indicator to show that the renewal of the certification is in progress.
- RenewalRequiredFlag; boolean; Indicator to show that the certification needs to be renewed.
- SectionId; integer; Section ID specified in the certification.
- StateProvinceCode; string; State Province Code specified in the certification.
- StateProvinceId; integer; State Province ID specified in the certification.
- Status; string; Indicates the status of the certification item
- SubmissionId; string; Unique ID for each candidate's submitted requests
- Title; string; Title of the certification item
- TotalAmount; integer; Total amount paid for the certification.
- VerifiedFlag; boolean; Indicator to show that the certification is verified.
-
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 : recruitingCECandidateCertificationItems
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 : recruitingCECandidateCertificationItems-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the certifications done by the candidate. -
CertificationId: integer
(int64)
Certification ID of the certification.
-
CertificationName: string
Title:
License or Certificate
Maximum Length:240
Name of the certification. -
CertificationNumber: string
Title:
Certificate Number
Maximum Length:240
Number assigned to the certification. -
CertificationURL: string
Title:
Certification URL
Maximum Length:2000
URL of the certification. -
Comments: string
(byte)
Title:
Comments
Comments for the certification. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount of the certification. -
CompletedTrainingUnits: string
Title:
Training Completed Units
Maximum Length:240
Number of training units completed for the certification. -
ContentItemId: integer
(int64)
Title:
License or Certificate
Unique identifier assigned to each content item. -
CountryCode: string
Title:
Country
Maximum Length:30
Country Code specified in the certification -
CountryId: integer
(int64)
Title:
Country
Country ID specified in the certification. -
EducationalEstablishment: string
Title:
Educational Establishment
Maximum Length:2000
Educational establishment that issued the certification. -
EducationalEstablishmentId: integer
(int64)
Title:
Establishment
Unique identifier assigned to the educational establishment. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the certification. -
FlowVersionId: integer
This gives the Service Metadata
-
IssueDate: string
(date)
Title:
Issue Date
Date on which the certification was issued -
IssuedBy: string
Title:
Issued By
Maximum Length:240
Name of the authority that issued the certification. -
LastRenewalDate: string
(date)
Title:
Last Renewal Date
Last date for renewal of the certification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue Year
Year when the certification was issued. -
RenewalDate: string
(date)
Title:
Renewal Date
Date on which the certification was renewed. -
RenewalInprogressFlag: boolean
Title:
Renewal In Progress
Maximum Length:30
Indicator to show that the renewal of the certification is in progress. -
RenewalRequiredFlag: boolean
Title:
Renewal Required
Maximum Length:30
Indicator to show that the certification needs to be renewed. -
Restrictions: string
(byte)
Title:
Restrictions
Restrictions for the certification. -
SectionId: integer
(int64)
Section ID specified in the certification.
-
StateProvinceCode: string
Title:
State
Maximum Length:360
State Province Code specified in the certification. -
StateProvinceId: integer
(int64)
Title:
State
State Province ID specified in the certification. -
Status: string
Title:
Status
Maximum Length:30
Indicates the status of the certification item -
SubmissionId: string
Unique ID for each candidate's submitted requests
-
Title: string
Title:
Title
Maximum Length:240
Title of the certification item -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount paid for the certification. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:30
Indicator to show that the certification is verified.
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.