Jump to

• Request
• Response
• Examples

My Approvals Search

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_search/_my_approval_search

Use this endpoint to retrieve a user's pending approvals waiting in a queue when there are quotes they need to approve.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.

Body ()

Root Schema : Transaction-_my_approval_searchCollectionRequest

Type: object

Show Source

• criteria: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.

{
    "type":"object",
    "properties":{
        "criteria":{
            "$ref":"#/definitions/queryDef"
        }
    }
}

Nested Schema : Query Definition

Type: object

Title: Query Definition

Captures the query definition for the current resource request.

Show Source

• actions: array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs: array childDefs
• expand: array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• fields: array fields
  Array of field names that you wanted returned in a request.
• state: boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

Nested Schema : actions

Type: array

Array of actions names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : childDefs

Type: array

Show Source

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/childQueryDef"
    }
}

Nested Schema : expand

Type: array

Array of child resource names that you want to expand so that the contents return with the parent in the same request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomains

Type: array

Array of field names, whose expanded domains are requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : fields

Type: array

Array of field names that you wanted returned in a request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Child query criteria.

Type: object

Title: Child query criteria.

Captures the query criteria for the child resource.

Show Source

• name: string
  Rest alias name of the child resource this query belongs to.
• queryDef: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive: boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_my_approval_searchCollectionResponse

Type: object

Back to Top

Examples

The following example shows how to retrieve a user's pending approvals waiting in a queue when there are quotes they need to approve by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_search/_my_approval_search

Request Body Sample

{
  "criteria": {
    "fields": [
      "projectName",
      "_id",
      "_lock_status",
      "_currency_pref",
      "mainMathInput_Float1"
    ],
    "orderby": [
      "_currency_pref:DESC",
      "projectName:ASC"
    ],
    "limit": 10,
    "offset": 20

  }
}

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqo"
    }
  ],
  "items": [{
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023106049,
      "projectName": "Super User's project 11/07/2023 08:13:39"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023123297,
      "projectName": "Super User's project 11/08/2023  22:06:16"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023123306,
      "projectName": "Super User's project 11/08/2023  22:06:16"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023120057,
      "projectName": "Super User's project 11/08/2023 07:43:34"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023120066,
      "projectName": "Super User's project 11/08/2023 07:43:54"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023123276,
      "projectName": "Super User's project 11/08/2023 21:53:31"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023123288,
      "projectName": "Super User's project 11/08/2023 22:05:37"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": null,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 3023123315,
      "projectName": "Super User's project 11/08/2023 22:06:16"
    }, {
      "_lock_status": null,
      "mainMathInput_Float1": 4.35,
      "_currency_pref": {
        "id": 14619668,
        "currencyCode": "USD",
        "links": [{
            "rel": "domain",
            "href": "http://sitename.oracle.com/rest/v16/currencies"
          }, {
            "rel": "canonical",
            "href": "http://sitename.oracle.com/rest/v16/currencies/USD"
          }
        ]
      },
      "_id": 15555481,
      "projectName": "Test"
    }
  ]
}

Back to Top