Jump to

• Request
• Response

Find the workload consolidation results matching the specified criteria

post

/hcmRestApi/resources/11.13.18.05/workloads/action/findByAdvancedSearchQuery

Finds the workload consolidation results matching the specified criteria such as department or location.

Request

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.

Supported Media Types

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

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

Root Schema : schema

Type: object

Show Source

• autocompleteQuery: string
  Indicates whether the query is completed automatically.
• displayFields: array displayFields
  Fields to display the workload consolidation response, such as Department, Skill, Workload Value, and Unit of Measure.
• filters: array filters
  Facet filters for the workload consolidation result set.
• limit: number
  Fetches size limit on the workload consolidation results.
• offset: number
  Finds the workload consolidation results using the specified offset.
• query: string
  Results for the workload consolidation query.
• searchFields: array searchFields
  Fields for the workload consolidation search results, such as Department and Location.
• sort: array sort
  Sort order for the workload consolidation result set.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Finds the workload consolidation results using the specified offset.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Results for the workload consolidation query.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Fetches size limit on the workload consolidation results.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Fields for the workload consolidation search results, such as Department and Location.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the workload consolidation result set.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the workload consolidation result set.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Fields to display the workload consolidation response, such as Department, Skill, Workload Value, and Unit of Measure.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is completed automatically.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Fields to display the workload consolidation response, such as Department, Skill, Workload Value, and Unit of Measure.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields to display the workload consolidation response, such as Department, Skill, Workload Value, and Unit of Measure.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the workload consolidation result set.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the workload consolidation result set.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Fields for the workload consolidation search results, such as Department and Location.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields for the workload consolidation search results, such as Department and Location.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the workload consolidation result set.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the workload consolidation result set.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "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"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "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

  Response returned for a workload consolidation query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Response returned for a workload consolidation query."
        }
    },
    "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":"Response returned for a workload consolidation query."
}

Response returned for a workload consolidation query.

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