Jump to

• Request
• Response

Method used to perform an search on asset qualifications.

post

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetQualifications/action/findByAdvancedSearchQuery

Method used to perform a search on asset qualifications based on qualification requirements.

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.

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
  Identifies the auto complete query to be used by the custom method to get the asset qualifications result.
• displayFields: array displayFields
  Identifies the fields to be returned by the custom method.
• filters: array filters
  Identifies the filter criteria to be used by the custom method to filter the asset qualifications result.
• limit: number
  Value that identifies the number of rows to be returned for pagination support.
• 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 asset qualifications result.
• searchFields: array searchFields
  Identifies the fields on which the search has to performed by the custom method.
• sort: array sort
  Identifies the sort criteria to be used by the custom method to sort the asset qualifications 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 asset qualifications result.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Value that identifies the number of rows to be returned for pagination support.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Identifies the fields on which the search has to performed by the custom method.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Identifies the filter criteria to be used by the custom method to filter the asset qualifications result.",
            "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 asset qualifications result.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Identifies the fields to be returned by the custom method.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Identifies the auto complete query to be used by the custom method to get the asset qualifications result.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Identifies the fields to be returned by the custom method.

Show Source

• Array of: string

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

Nested Schema : filters

Type: array

Identifies the filter criteria to be used by the custom method to filter the asset qualifications result.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Identifies the filter criteria to be used by the custom method to filter the asset qualifications result.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Identifies the fields on which the search has to performed by the custom method.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Identifies the fields on which the search has to performed by the custom method.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Identifies the sort criteria to be used by the custom method to sort the asset qualifications 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 asset qualifications 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

  If the action is completed successfully, then the search result returns the asset qualifications.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"If the action is completed successfully, then the search result returns the asset qualifications."
        }
    },
    "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 is completed successfully, then the search result returns the asset qualifications."
}

If the action is completed successfully, then the search result returns the asset qualifications.

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