Jump to

• Request
• Response

Title for the custom action to return available persons for assignment.

post

/fscmRestApi/resources/11.13.18.05/maintenanceResourceAvailablePersons/action/findByAdvancedSearchQuery

Description for the custom action to return available persons for assignment.

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

• autocompleteQuery: string
  Get details using an autocomplete query.
• displayFields: array displayFields
  Identifies the display fields to be returned by the custom method for the available persons result.
• filters: array filters
  Get details based on filters.
• limit: number
  Get the response with limit to support pagination.
• offset: number
  Value that identifies the offset for pagination support.
• query: string
  Identifies the query to be used by the custom method to get the available persons result.
• searchFields: array searchFields
  Identifies the search fields to be used by the custom method to get the available persons result.
• sort: array sort
  Identifies the sort criteria to be used by the custom method to sort the available persons result.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Value that identifies the offset for pagination support.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Identifies the query to be used by the custom method to get the available persons result.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Get the response with limit to support pagination.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Identifies the search fields to be used by the custom method to get the available persons result.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Get details based on filters.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Identifies the sort criteria to be used by the custom method to sort the available persons result.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Identifies the display fields to be returned by the custom method for the available persons result.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Get details using an autocomplete query.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Identifies the display fields to be returned by the custom method for the available persons result.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Identifies the display fields to be returned by the custom method for the available persons result.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Get details based on filters.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Get details based on filters.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Identifies the search fields to be used by the custom method to get the available persons result.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Identifies the search fields to be used by the custom method to get the available persons result.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Identifies the sort criteria to be used by the custom method to sort the available persons result.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Identifies the sort criteria to be used by the custom method to sort the available persons result.",
    "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

  Indicates the return element for the custom action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Indicates the return element for the custom action."
        }
    },
    "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":"Indicates the return element for the custom action."
}

Indicates the return element for the custom action.

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