Jump to

• Request
• Response

Finds areas of responsibility template information

post

/hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/findByAdvancedSearch

Finds areas of responsibility template records that match the specified advanced search criteria. This returns the filtered records.

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
  Autocomplete query for the specified advanced search criteria.
• displayFields: array displayFields
  Display fields for the specified advanced search criteria.
• filters: array filters
  Filters for the specified advanced search criteria.
• limit: number
  Limit for the advanced search results.
• offset: number
  Offset for the specified advanced search criteria.
• query: string
  Query for the specified advanced search criteria.
• searchFields: array searchFields
  Search fields for the specified advanced search criteria.
• sort: array sort
  Sort order for the specified advanced search criteria.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset for the specified advanced search criteria.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query for the specified advanced search criteria.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit for the advanced search results.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the specified advanced search criteria.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters for the specified advanced search criteria.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the specified advanced search criteria.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the specified advanced search criteria.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query for the specified advanced search criteria.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the specified advanced search criteria.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the specified advanced search criteria.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters for the specified advanced search criteria.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters for the specified advanced search criteria.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the specified advanced search criteria.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the specified advanced search criteria.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the specified advanced search criteria.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

  Results returned for the specified advanced search criteria.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Results returned for the specified advanced search criteria."
        }
    },
    "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 returned for the specified advanced search criteria."
}

Results returned for the specified advanced search criteria.

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