Jump to

• Request
• Response
• Examples

Get all jobs

get

/hcmRestApi/resources/11.13.18.05/jobsLov

Request

Query Parameters

• effectiveDate: string
  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
• 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 all jobs that match the specified primary key criteria.
    Finder Variables
    • EffectiveEndDate; string; Date at the end of the period within which the job is effective.
    • EffectiveStartDate; string; Date at the beginning of the period within which the job is effective.
    • JobId; integer; Surrogate identifier for the job.
  • findByBusinessUnit Finds all jobs that match the specified business unit criteria.
    Finder Variables
    • BusinessUnitId; integer; Unique identifier for a business unit.
    • BusinessUnitName; string; Name of the business unit that the job belongs to.
    • IncludeCommonSet; boolean; Name of the common set that the job belongs to.
  • findByJobId Finds all jobs that match the specified criteria.
    Finder Variables
    • JobId; integer; Unique identifier for the job.
    • SysEffectiveDate; object;
  • findBySet Finds all jobs that match the specified set criteria.
    Finder Variables
    • SetCode; string; Code of the set that the job belongs to.
    • SetId; integer; Surrogate identifier for the set that the job belongs to.
    • SetName; string; Name of the set that the job belongs to.
    • SysEffectiveDate; object;
  • findByWord Finds all jobs that match the specified word.
    Finder Variables
    • FilterAttributes; string; Attributes for the search terms.
    • IsBenchmarkJob; boolean; Indicates whether the job is a benchmark job.
    • SchedulingGroup; string; Finds all the jobs that match the specified scheduling group.
    • SearchTerms; string; Search term criteria to retrieve data.
    • SetId; integer; Unique identifier for a set.
    • SysEffectiveDate; object;
  • findNextProgressionJob Finds all jobs that match the next progression job criteria.
    Finder Variables
    • BaseJobId; integer; Unique identifier for the base job.
    • SysEffectiveDate; object;
• 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:
  

  • ActiveStatus; string; Status of the job such as active or inactive.
  • JobCode; string; Unique code for the job within the set.
  • JobFamilyId; integer; Unique identifier of the job family associated with the job.
  • JobFamilyName; string; Name of the job family associated with the job.
  • JobFunctionCode; string; Code of the job function for the job.
  • JobFunctionName; string; Name of the job function for the job.
  • JobId; integer; Surrogate identifier for the job.
  • JobName; string; Name of the job.
  • ManagerLevel; string; Management level of the job.
  • SchedulingGroup; string; Code of the scheduling group to which the job belongs.
  • SchedulingGroupName; string; Name of the scheduling group to which the job belongs.
  • SetCode; string; Code of the set that the job belongs to.
  • SetId; integer; Surrogate identifier for the set the job belongs to.
  • SetName; string; Name of the set that the job belongs to.
• 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

• 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 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 : jobsLov

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/jobsLov-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jobsLov-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jobsLov-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 : jobsLov-item-response

Type: object

Show Source

• ActiveStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Status of the job such as active or inactive.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Read Only: true

  Date at the end of the period within which the job is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Read Only: true

  Date at the beginning of the period within which the job is effective.
• JobCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Unique code for the job within the set.
• JobFamilyId: integer (int64)
  Read Only: true

  Unique identifier of the job family associated with the job.
• JobFamilyName: string
  Title: Job Family

  Read Only: true

  Maximum Length: 240

  Name of the job family associated with the job.
• JobFunctionCode: string
  Title: Job Function Code

  Read Only: true

  Maximum Length: 30

  Code of the job function for the job.
• JobFunctionName: string
  Title: Job Function

  Read Only: true

  Maximum Length: 80

  Name of the job function for the job.
• JobId: integer (int64)
  Read Only: true

  Surrogate identifier for the job.
• JobName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the job.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerLevel: string
  Title: Management Level

  Read Only: true

  Maximum Length: 150

  Management level of the job.
• SchedulingGroup: string
  Title: Scheduling Group Code

  Read Only: true

  Maximum Length: 30

  Code of the scheduling group to which the job belongs.
• SchedulingGroupName: string
  Title: Scheduling Group

  Read Only: true

  Maximum Length: 80

  Name of the scheduling group to which the job belongs.
• SetCode: string
  Title: Set Code

  Read Only: true

  Maximum Length: 30

  Code of the set that the job belongs to.
• SetId: integer (int64)
  Read Only: true

  Surrogate identifier for the set the job belongs to.
• SetName: string
  Title: Job Set

  Read Only: true

  Maximum Length: 80

  Name of the set that the job belongs to.

{
    "type":"object",
    "properties":{
        "SchedulingGroup":{
            "title":"Scheduling Group Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the scheduling group to which the job belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the period within which the job is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JobName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetName":{
            "title":"Job Set",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the set that the job belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFunctionCode":{
            "title":"Job Function Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the job function for the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetCode":{
            "title":"Set Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the set that the job belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the job such as active or inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFunctionName":{
            "title":"Job Function",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the job function for the job.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyName":{
            "title":"Job Family",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job family associated with the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Unique identifier of the job family associated with the job.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique code for the job within the set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SetId":{
            "type":"integer",
            "description":"Surrogate identifier for the set the job belongs to.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period within which the job is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JobId":{
            "type":"integer",
            "description":"Surrogate identifier for the job.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManagerLevel":{
            "title":"Management Level",
            "maxLength":"150",
            "type":"string",
            "description":"Management level of the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulingGroupName":{
            "title":"Scheduling Group",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the scheduling group to which the job belongs.",
            "nullable":false,
            "readOnly":true,
            "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

Examples

The following example shows how to retrieve all the jobs by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4""-X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/jobsLov"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  "items": [
      {
          "JobId": 100000000000036,
          "EffectiveStartDate": "2001-08-08",
          "EffectiveEndDate": "4712-12-31",
          "JobCode": "10710",
          "JobName": "10710.Applications Developer 1",
          "ActiveStatus": "A",
          "JobFunctionCode": "ADMIN",
          "JobFunctionName": "Administrative",
          "JobFamilyId": 100010024200043,
          "JobFamilyName": "Logistics Jobs",
          "ManagerLevel": null,
          "SetId": 0,
          "SetCode": "COMMON",
          "SetName": "Common Set",
          "links": [2]
      },
      {
          "JobId": 100000000000029,
          "EffectiveStartDate": "2001-08-01",
          "EffectiveEndDate": "4712-12-31",
          "JobCode": "10720",
          "JobName": "10720.Applications Developer 2",
          "ActiveStatus": "A",
          "JobFunctionCode": "MANAG",
          "JobFunctionName": "Managerial",
          "JobFamilyId": 100000011571422,
          "JobFamilyName": "Finance & Accounting",
          "ManagerLevel": null,
          "SetId": 0,
          "SetCode": "COMMON",
          "SetName": "Common Set",
          "links": [2]
      },
      {
          "JobId": 100000000000031,
          "EffectiveStartDate": "2001-08-03",
          "EffectiveEndDate": "4712-12-31",
          "JobCode": "10740",
          "JobName": "10740.Applications Developer 4",
          "ActiveStatus": "A",
          "JobFunctionCode": "SALES",
          "JobFunctionName": "Sales",
          "JobFamilyId": 100000018146380,
          "JobFamilyName": "Food Services Management and Operations",
          "ManagerLevel": null,
          "SetId": 0,
          "SetCode": "COMMON",
          "SetName": "Common Set",
           "links": [2]
		         {
               ...}
  ]
}

Back to Top