REST API for Oracle Fusion Cloud HCM

Get all journey counts

get

/hcmRestApi/resources/11.13.18.05/journeyCounts

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 all journey counts that match the specified primary key criteria.
  Finder Variables
  - SearchId; integer; Unique identifier for the search.
- findAggregations Finds all journey counts assigned to workers that match the specified criteria.
  Finder Variables
  - CategoryFilter; string; Filter attribute to retrieve journeys assigned to workers by category.
  - CodeFilter; string; Filter attribute to retrieve journeys assigned to workers by code.
  - Facets; string; Facet names to group journeys assigned to workers.
  - LevelFilter; string; Filter attribute to retrieve count of journeys based on journey level.
  - RequiredFilter; string; Filter attribute to retrieve required journeys assigned to workers.
  - SearchContext; string; Search context to find counts of journeys assigned to workers.
  - SearchTerms; string; Search criteria to find counts of journeys assigned to workers.
  - StatusFilter; string; Filter attribute to retrieve journeys assigned to workers by status.
  - SubCategoryFilter; string; Filter attribute to retrieve journeys assigned to workers by subcategory.
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:
- SearchContext; string; Context for the worker journey search. Used in REST service describe only.
- SearchId; integer; Unique identifier for the worker journey search. Used in REST service describe only.
- SearchTerms; string; Search criteria used to search for worker journeys. Used in REST service describe only.
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.

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.

Root Schema : journeyCounts

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/journeyCounts-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object journeyCounts-item-response

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

Type: object

Show Source

facets: array Facets

Title: Facets

The facets resource is a child of the journeyCounts resource and includes all the search filters in the worker journey.
links: array Links

Title: Links

The link relations associated with the resource instance.
SearchContext: string

Title: Search Context

Read Only: true

Context for the worker journey search. Used in REST service describe only.
SearchId: integer

Title: Search ID

Read Only: true

Default Value: 1

Unique identifier for the worker journey search. Used in REST service describe only.
SearchTerms: string

Title: Search Term

Read Only: true

Search criteria used to search for worker journeys. Used in REST service describe only.

{
    "type":"object",
    "properties":{
        "SearchId":{
            "title":"Search ID",
            "type":"integer",
            "description":"Unique identifier for the worker journey search. Used in REST service describe only.",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SearchContext":{
            "title":"Search Context",
            "type":"string",
            "description":"Context for the worker journey search. Used in REST service describe only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SearchTerms":{
            "title":"Search Term",
            "type":"string",
            "description":"Search criteria used to search for worker journeys. Used in REST service describe only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "facets":{
            "title":"Facets",
            "type":"array",
            "description":"The facets resource is a child of the journeyCounts resource and includes all the search filters in the worker journey.",
            "items":{
                "$ref":"#/components/schemas/journeyCounts-facets-item-response"
            }
        }
    }
}

Nested Schema : Facets

Type: array

Title: Facets

The facets resource is a child of the journeyCounts resource and includes all the search filters in the worker journey.

Show Source

Array of: object journeyCounts-facets-item-response

{
    "title":"Facets",
    "type":"array",
    "description":"The facets resource is a child of the journeyCounts resource and includes all the search filters in the worker journey.",
    "items":{
        "$ref":"#/components/schemas/journeyCounts-facets-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 : journeyCounts-facets-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
name: string

Title: Name

Read Only: true

Name of the group of search results that can be based on status, category, or required attributes.
values: array Values

Title: Values

The values resource is a child of the journeyCounts resource and includes all the values for the search filters in the worker journey.

{
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "type":"string",
            "description":"Name of the group of search results that can be based on status, category, or required attributes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "values":{
            "title":"Values",
            "type":"array",
            "description":"The values resource is a child of the journeyCounts resource and includes all the values for the search filters in the worker journey.",
            "items":{
                "$ref":"#/components/schemas/journeyCounts-facets-values-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 : Values

Type: array

Title: Values

The values resource is a child of the journeyCounts resource and includes all the values for the search filters in the worker journey.

Show Source

Array of: object journeyCounts-facets-values-item-response

{
    "title":"Values",
    "type":"array",
    "description":"The values resource is a child of the journeyCounts resource and includes all the values for the search filters in the worker journey.",
    "items":{
        "$ref":"#/components/schemas/journeyCounts-facets-values-item-response"
    }
}

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."
        }
    }
}

Nested Schema : journeyCounts-facets-values-item-response

Type: object

Show Source

code: string

Title: Code

Read Only: true

Identifiers for each filter type such as status, category, or required attributes. For example, code for Category is ONBOARD.
count: integer

Title: Count

Read Only: true

Number of records based on a specific filter type. For example, if code is ONBOARD, count can be 5.
links: array Links

Title: Links

The link relations associated with the resource instance.
value: string

Title: Value

Read Only: true

Display name of the code. For example, if code is ONBOARD, then value is Onboarding.

{
    "type":"object",
    "properties":{
        "count":{
            "title":"Count",
            "type":"integer",
            "description":"Number of records based on a specific filter type. For example, if code is ONBOARD, count can be 5.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "code":{
            "title":"Code",
            "type":"string",
            "description":"Identifiers for each filter type such as status, category, or required attributes. For example, code for Category is ONBOARD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "value":{
            "title":"Value",
            "type":"string",
            "description":"Display name of the code. For example, if code is ONBOARD, then value is Onboarding.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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"
    }
}