Jump to

• Request
• Response
• Examples

List Applications

get

/decision/api/v1/applications

Retrieves a list of active applications that contain a decision model. The list of applications retrieved include both decision applications, and process applications with a local decision. A successful response includes the application identifiers (applicationId).

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation Successful

Body ()

Root Schema : Applications

Title: Applications

Match All

Show Source

• object Links
  Title: Links
• object Applications-allOf[1]

{
    "title":"Applications",
    "allOf":[
        {
            "$ref":"#/components/schemas/Links"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecisionApplication"
                    }
                }
            },
            "required":[
                "items"
            ]
        }
    ]
}

Nested Schema : Links

Type: object

Title: Links

Show Source

• links: array links

{
    "title":"Links",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : Applications-allOf[1]

Type: object

Show Source

• items(required): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecisionApplication"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: Application
  Title: Application

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecisionApplication"
    }
}

Nested Schema : Application

Title: Application

Match All

Show Source

• object Links
  Title: Links
• object Application-allOf[1]

{
    "title":"Application",
    "allOf":[
        {
            "$ref":"#/components/schemas/Links"
        },
        {
            "type":"object",
            "properties":{
                "applicationId":{
                    "type":"string"
                }
            },
            "required":[
                "applicationId"
            ]
        }
    ]
}

Nested Schema : Application-allOf[1]

Type: object

Show Source

• applicationId(required): string

{
    "type":"object",
    "properties":{
        "applicationId":{
            "type":"string"
        }
    },
    "required":[
        "applicationId"
    ]
}

400 Response

Bad request

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

500 Response

Internal error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Back to Top

Examples

Example: Get list of all applications

The following example shows how to get list of all applications by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

curl -X 'GET' \   'https://oracle.com/decision/api/v1/applications' \   -H 'accept:
      application/json'

Example Format of 200 Operation Successful Response

{
  "links": [
    {
      "href": "string",
      "hreflang": "string",
      "length": 0,
      "rel": "string",
      "title": "string",
      "type": "string",
      "mediaType": "string",
      "message": "string",
      "code": 600
    }
  ],
  "items": [
    {
      "links": [
        {
          "href": "string",
          "hreflang": "string",
          "length": 0,
          "rel": "string",
          "title": "string",
          "type": "string",
          "mediaType": "string",
          "message": "string",
          "code": 600
        }
      ],
      "applicationId": "string"
    }
  ]
}

Example Format of Bad Request Response

{
  "errorCode": "string",
  "status": 0,
  "message": "string",
  "details": "string",
  "cause": "string",
  "opcRequestId": "string"
}

Back to Top