Jump to

• Request
• Response

Aggregation for time events

post

/hcmRestApi/resources/11.13.18.05/timeEvents/action/getAggregations

Calculates time event aggregations.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• facets: array facets
  Facets used to aggregate time events such as relative range.
• filters: array filters
  Criteria used to aggregate time events, such as group name, start date or end date.
• query: string
  Keyword value, such as the time event aggregation start date or stop date.
• searchFields: array searchFields
  Search criteria from the keyword field, such as person name or number.

{
    "type":"object",
    "properties":{
        "query":{
            "type":"string",
            "description":"Keyword value, such as the time event aggregation start date or stop date.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search criteria from the keyword field, such as person name or number.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Criteria used to aggregate time events, such as group name, start date or end date.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "facets":{
            "type":"array",
            "description":"Facets used to aggregate time events such as relative range.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : facets

Type: array

Facets used to aggregate time events such as relative range.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Facets used to aggregate time events such as relative range.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Criteria used to aggregate time events, such as group name, start date or end date.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Criteria used to aggregate time events, such as group name, start date or end date.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search criteria from the keyword field, such as person name or number.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search criteria from the keyword field, such as person name or number.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Results of the aggregation of the selected time events.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Results of the aggregation of the selected time events."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"Results of the aggregation of the selected time events."
}

Results of the aggregation of the selected time events.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top