Jump to

• Request
• Response
• Examples

Get Favorite Process Inocations

post

/rest/v16/favorites/actions/getProcessInvocations

This endpoint returns the process invocations for favorites.

Request

Supported Media Types

• application/json

Body ()

Root Schema : favorites-getProcessInvocationsCollectionRequest

Type: object

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : favorites-getProcessInvocationsCollectionResponse

Type: object

Show Source

• result: object favoriteProcessInvocations-collection

{
    "type":"object",
    "properties":{
        "result":{
            "$ref":"#/definitions/favoriteProcessInvocations-collection"
        }
    }
}

Nested Schema : favoriteProcessInvocations-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server. If no limit was specified or if a limit greater than 1000 is specified, a pagination limit of 1000 will be used
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server. If no limit was specified or if a limit greater than 1000 is specified, a pagination limit of 1000 will be used"
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/favoriteProcessInvocations"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Favorite Process Invocations
  Title: Favorite Process Invocations

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

Nested Schema : Favorite Process Invocations

Type: object

Title: Favorite Process Invocations

Show Source

• description: string
  Title: Description
• name: string
  Title: Name
• targetType: string
  Title: Target Type
• variableName: string
  Title: Variable Name

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"",
            "title":"Description"
        },
        "name":{
            "type":"string",
            "description":"",
            "title":"Name"
        },
        "targetType":{
            "type":"string",
            "description":"",
            "title":"Target Type"
        },
        "variableName":{
            "type":"string",
            "description":"",
            "title":"Variable Name"
        }
    },
    "title":"Favorite Process Invocations"
}

Back to Top

Examples

The following example shows how to return the process invocations for favorite 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"
https://sitename.oracle.com/rest/v16/favorites/actions/getProcessInvocations

Response Body Sample

{
  "result": {
    "hasMore": false,
    "items": [{
        "variableName": "CM_4174166",
        "name": "Create Quotes",
        "description": "Create Quote",
        "targetType": "start"
      }, {
        "variableName": "CM_7065206",
        "name": "Add to Cart (Quotes)",
        "description": "",
        "targetType": "shoppingCart"
      }, {
        "variableName": "CM_18321147",
        "name": "Add from Favorite",
        "description": "",
        "targetType": "start"
      }
    ]
  }
}

Back to Top