Jump to

• Request
• Response

Get details based on search, filter, or sort criteria with the specifed display fields in the response

post

/fscmRestApi/resources/11.13.18.05/assetWarrantyClaims/action/findByAdvancedSearchQuery

Get the details based on search, filter, or sort criteria with the specifed display fields in the response. It supports pagination with limit and offset.

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 with an autocomplete query
• displayFields: array displayFields
  Get details based on search, filter, or sort criteria with the specified display fields in the response
• filters: array filters
  Get details based on filters
• limit: number
  Get the response with limit to support pagination
• offset: number
  Get the response with offset to support pagination
• query: string
  Get details with the specified query in the response
• searchFields: array searchFields
  Get details based on search, filter, and sort criteria with the specified search fields in the response
• sort: array sort
  Get details based on sort criteria with the specified display fields in the response

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Get the response with offset to support pagination",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Get details with the specified query in the response",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Get the response with limit to support pagination",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Get details based on search, filter, and sort criteria with the specified search fields in the response",
            "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":"Get details based on sort criteria with the specified display fields in the response",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Get details based on search, filter, or sort criteria with the specified display fields in the response",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Get details with an autocomplete query",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Get details based on search, filter, or sort criteria with the specified display fields in the response

Show Source

• Array of: string

{
    "type":"array",
    "description":"Get details based on search, filter, or sort criteria with the specified display fields in the response",
    "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

Get details based on search, filter, and sort criteria with the specified search fields in the response

Show Source

• Array of: string

{
    "type":"array",
    "description":"Get details based on search, filter, and sort criteria with the specified search fields in the response",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Get details based on sort criteria with the specified display fields in the response

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Get details based on sort criteria with the specified display fields in the response",
    "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

  If the action completes successfully, then the response for find by advanced search query will begin

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"If the action completes successfully, then the response for find by advanced search query will begin"
        }
    },
    "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":"If the action completes successfully, then the response for find by advanced search query will begin"
}

If the action completes successfully, then the response for find by advanced search query will begin

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