Jump to

• Request
• Response

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
• 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 Top

Response

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.

Body ()

Root Schema : recruitingCECandidateCertificationItems

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateCertificationItems-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCECandidateCertificationItems-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateCertificationItems-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCECandidateCertificationItems-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "FlowVersionId":{
            "type":"integer",
            "description":"This gives the Service Metadata",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalRequiredFlag":{
            "title":"Renewal Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the certification needs to be renewed.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalIssueYear":{
            "title":"Original Issue Year",
            "type":"integer",
            "description":"Year when the certification was issued.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"License or Certificate",
            "type":"integer",
            "description":"Unique identifier assigned to each content item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Completed amount of the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Country Code specified in the certification",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedTrainingUnits":{
            "title":"Training Completed Units",
            "maxLength":240,
            "type":"string",
            "description":"Number of training units completed for the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the certifications done by the candidate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Restrictions":{
            "title":"Restrictions",
            "type":"string",
            "description":"Restrictions for the certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CountryId":{
            "title":"Country",
            "type":"integer",
            "description":"Country ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the certification item",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationURL":{
            "title":"Certification URL",
            "maxLength":2000,
            "type":"string",
            "description":"URL of the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "VerifiedFlag":{
            "title":"Verified",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the certification is verified.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalInprogressFlag":{
            "title":"Renewal In Progress",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the renewal of the certification is in progress.",
            "nullable":true,
            "x-queryable":true
        },
        "StateProvinceId":{
            "title":"State",
            "type":"integer",
            "description":"State Province ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments for the certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvinceCode":{
            "title":"State",
            "maxLength":360,
            "type":"string",
            "description":"State Province Code specified in the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Date on which the certification was issued",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the certification item",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount paid for the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastRenewalDate":{
            "title":"Last Renewal Date",
            "type":"string",
            "description":"Last date for renewal of the certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationId":{
            "type":"integer",
            "description":"Certification ID of the certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"Date on which the certification was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationName":{
            "title":"License or Certificate",
            "maxLength":240,
            "type":"string",
            "description":"Name of the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EducationalEstablishment":{
            "title":"Educational Establishment",
            "maxLength":2000,
            "type":"string",
            "description":"Educational establishment that issued the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "EducationalEstablishmentId":{
            "title":"Establishment",
            "type":"integer",
            "description":"Unique identifier assigned to the educational establishment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"string",
            "description":"Unique ID for each candidate's submitted requests",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationNumber":{
            "title":"Certificate Number",
            "maxLength":240,
            "type":"string",
            "description":"Number assigned to the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuedBy":{
            "title":"Issued By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the authority that issued the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top