Jump to

• Request
• Response

Find the workforce schedule that matches the specified criteria

post

/hcmRestApi/resources/11.13.18.05/workforceSchedules/action/findByAdvancedSearchQuery

Finds the workforce schedule that matches the specified criteria, such as name, category, or status.

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. Valid values are Y and N. The default value is Y.
• displayFields: array displayFields
  Display fields for the workforce schedule search response, such as Name, Category, and Status.
• filters: array filters
  Facet filters for the workforce schedule search.
• limit: number
  Fetch size limit for workforce schedule results. The default value is 25.
• offset: number
  Start range for the workforce schedule results.
• query: string
  Keyword query search for the workforce schedule.
• searchFields: array searchFields
  Search fields for the workforce schedule keyword query, such as Name, Category, and Status.
• sort: array sort
  Sort order for the workforce schedule search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Start range for the workforce schedule results.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword query search for the workforce schedule.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Fetch size limit for workforce schedule results. The default value is 25.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the workforce schedule keyword query, such as Name, Category, and Status.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the workforce schedule search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the workforce schedule search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the workforce schedule search response, such as Name, Category, and Status.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is completed automatically. Valid values are Y and N. The default value is Y.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the workforce schedule search response, such as Name, Category, and Status.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the workforce schedule search response, such as Name, Category, and Status.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the workforce schedule search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the workforce schedule search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the workforce schedule keyword query, such as Name, Category, and Status.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the workforce schedule keyword query, such as Name, Category, and Status.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the workforce schedule search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the workforce schedule search results.",
    "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

  Search results for a workforce schedule query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Search results for a workforce schedule 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":"Search results for a workforce schedule query."
}

Search results for a workforce schedule 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