Jump to

• Request
• Response
• Examples

Get Application Details

get

/decision/api/v1/applications/{appId}

Get the details of activated or deployed decision or a process application specified by the applicationId.

Request

Path Parameters

• appId(required): string
  Name of the application

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DecisionApplicationDetails

Match All

Show Source

• allOf Application
  Title: Application
• object CommonDetails
  Title: CommonDetails

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DecisionApplication"
        },
        {
            "$ref":"#/components/schemas/CommonDetails"
        }
    ]
}

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 : 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 : Application-allOf[1]

Type: object

Show Source

• applicationId(required): string

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

Nested Schema : CommonDetails

Type: object

Title: CommonDetails

Show Source

• createdBy: string
• createdTime: string
  Example: 2022-08-29T09:12:33.001Z
• description: string
• lastChangedBy: string
• lastChangedTime: string
  Example: 2022-08-29T09:12:33.001Z

{
    "title":"CommonDetails",
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "createdTime":{
            "type":"string",
            "example":"2022-08-29T09:12:33.001Z"
        },
        "lastChangedTime":{
            "type":"string",
            "example":"2022-08-29T09:12:33.001Z"
        },
        "createdBy":{
            "type":"string"
        },
        "lastChangedBy":{
            "type":"string"
        }
    }
}

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
        }
    }
}

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"
        }
    }
}

404 Response

Resource not found

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 details of Invoicing application

The following example shows how to get details of a decision application 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/Invoicing' \   -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
    }
  ],
  "applicationId": "string",
  "description": "string",
  "createdTime": "2022-08-29T09:12:33.001Z",
  "lastChangedTime": "2022-08-29T09:12:33.001Z",
  "createdBy": "string",
  "lastChangedBy": "string"
}

Example Format of Bad Request Response

UnauthorizedMedia typeapplication/jsonExample ValueSchema{
  "errorCode": "string",
  "status": 0,
  "message": "string",
  "details": "string",
  "cause": "string",
  "opcRequestId": "string"
}

Back to Top