Jump to

• Request
• Response

Run advanced search on assignment statuses.

post

/hcmRestApi/resources/11.13.18.05/assignmentStatuses/action/findByAdvancedSearchQuery

Runs an advanced search on assignment statuses using the specified query criteria.

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

• displayFields: array displayFields
  Display fields for the advanced search on assignment statuses.
• filters: array filters
  Filter conditions for the advanced search on assignment statuses.
• limit: number
  Limit value for the advanced search on assignment statuses.
• offset: number
  Offset value for the advanced search on assignment statuses.
• query: string
  Query text for the advanced search on assignment statuses.
• sort: array sort
  Sort order for the advanced search on assignment statuses.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset value for the advanced search on assignment statuses.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query text for the advanced search on assignment statuses.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit value for the advanced search on assignment statuses.",
            "nullable":true
        },
        "filters":{
            "type":"array",
            "description":"Filter conditions for the advanced search on assignment statuses.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the advanced search on assignment statuses.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the advanced search on assignment statuses.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the advanced search on assignment statuses.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the advanced search on assignment statuses.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filter conditions for the advanced search on assignment statuses.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filter conditions for the advanced search on assignment statuses.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sort order for the advanced search on assignment statuses.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the advanced search on assignment statuses.",
    "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

  Return option for the advanced search on assignment statuses.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Return option for the advanced search on assignment statuses."
        }
    },
    "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":"Return option for the advanced search on assignment statuses."
}

Return option for the advanced search on assignment statuses.

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