Jump to

• Request
• Response

Get a Process Interface Schema

get

/process/api/v1/process-interfaces/{id}/schemas/{name}

Get a Process interface schema with given Id and schema name

Request

Path Parameters

• id(required): string
  Process Interface Id
• name(required): string
  Process Interface schema name

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Actual endpoint which customer requested

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ProcessInterface

Match All

Show Source

• object CommonModel
• object ProcessInterface-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "required":[
                "id"
            ],
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"ID of interface"
                },
                "type":{
                    "type":"string",
                    "description":"Type of Interface"
                },
                "title":{
                    "type":"string",
                    "description":"Interface of Title"
                },
                "description":{
                    "type":"string",
                    "description":"Interface description"
                },
                "formMetadataURL":{
                    "type":"string",
                    "description":"Form url associated with the process"
                },
                "inputs":{
                    "type":"array",
                    "description":"Input arguments of this interface",
                    "items":{
                        "$ref":"#/components/schemas/IOArgument"
                    }
                },
                "outputs":{
                    "type":"array",
                    "description":"Output arguments of this interface",
                    "items":{
                        "$ref":"#/components/schemas/IOArgument"
                    }
                },
                "defaultInterface":{
                    "type":"boolean",
                    "description":"If this is the default interface of the definition"
                },
                "definitionId":{
                    "type":"string",
                    "description":"Definition ID"
                },
                "definitionType":{
                    "type":"string",
                    "description":"Definition type. PROCESS or DP"
                },
                "activityId":{
                    "type":"string",
                    "description":"Id of the Activity in definition"
                },
                "applicationName":{
                    "type":"string",
                    "description":"Application Name"
                },
                "applicationTitle":{
                    "type":"string",
                    "description":"Application Title"
                },
                "applicationDescription":{
                    "type":"string",
                    "description":"Application Description"
                },
                "definitionTitle":{
                    "type":"string",
                    "description":"Definition Title"
                },
                "definitionDescription":{
                    "type":"string",
                    "description":"Definition Description"
                },
                "version":{
                    "type":"string",
                    "description":"Application Version"
                },
                "defaultVersion":{
                    "type":"boolean",
                    "description":"If application is the default version"
                },
                "definitionName":{
                    "type":"string",
                    "description":"Definition name"
                },
                "definitionKey":{
                    "type":"string",
                    "description":"Definition key"
                },
                "operationName":{
                    "type":"string",
                    "description":"operation name"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : ProcessInterface-allOf[1]

Type: object

Show Source

• activityId: string
  Id of the Activity in definition
• applicationDescription: string
  Application Description
• applicationName: string
  Application Name
• applicationTitle: string
  Application Title
• defaultInterface: boolean
  If this is the default interface of the definition
• defaultVersion: boolean
  If application is the default version
• definitionDescription: string
  Definition Description
• definitionId: string
  Definition ID
• definitionKey: string
  Definition key
• definitionName: string
  Definition name
• definitionTitle: string
  Definition Title
• definitionType: string
  Definition type. PROCESS or DP
• description: string
  Interface description
• formMetadataURL: string
  Form url associated with the process
• id(required): string
  ID of interface
• inputs: array inputs
  Input arguments of this interface
• operationName: string
  operation name
• outputs: array outputs
  Output arguments of this interface
• title: string
  Interface of Title
• type: string
  Type of Interface
• version: string
  Application Version

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of interface"
        },
        "type":{
            "type":"string",
            "description":"Type of Interface"
        },
        "title":{
            "type":"string",
            "description":"Interface of Title"
        },
        "description":{
            "type":"string",
            "description":"Interface description"
        },
        "formMetadataURL":{
            "type":"string",
            "description":"Form url associated with the process"
        },
        "inputs":{
            "type":"array",
            "description":"Input arguments of this interface",
            "items":{
                "$ref":"#/components/schemas/IOArgument"
            }
        },
        "outputs":{
            "type":"array",
            "description":"Output arguments of this interface",
            "items":{
                "$ref":"#/components/schemas/IOArgument"
            }
        },
        "defaultInterface":{
            "type":"boolean",
            "description":"If this is the default interface of the definition"
        },
        "definitionId":{
            "type":"string",
            "description":"Definition ID"
        },
        "definitionType":{
            "type":"string",
            "description":"Definition type. PROCESS or DP"
        },
        "activityId":{
            "type":"string",
            "description":"Id of the Activity in definition"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "applicationTitle":{
            "type":"string",
            "description":"Application Title"
        },
        "applicationDescription":{
            "type":"string",
            "description":"Application Description"
        },
        "definitionTitle":{
            "type":"string",
            "description":"Definition Title"
        },
        "definitionDescription":{
            "type":"string",
            "description":"Definition Description"
        },
        "version":{
            "type":"string",
            "description":"Application Version"
        },
        "defaultVersion":{
            "type":"boolean",
            "description":"If application is the default version"
        },
        "definitionName":{
            "type":"string",
            "description":"Definition name"
        },
        "definitionKey":{
            "type":"string",
            "description":"Definition key"
        },
        "operationName":{
            "type":"string",
            "description":"operation name"
        }
    }
}

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 : inputs

Type: array

Input arguments of this interface

Show Source

• Array of: object IOArgument

{
    "type":"array",
    "description":"Input arguments of this interface",
    "items":{
        "$ref":"#/components/schemas/IOArgument"
    }
}

Nested Schema : outputs

Type: array

Output arguments of this interface

Show Source

• Array of: object IOArgument

{
    "type":"array",
    "description":"Output arguments of this interface",
    "items":{
        "$ref":"#/components/schemas/IOArgument"
    }
}

Nested Schema : IOArgument

Type: object

Show Source

• name(required): string
  Name of argument
• schemaDefinition: string
  Schema definition
• schemaRef: string
  Schema link if data type is complex
• type(required): string
  Data type of argument or name of schema (if not primitive)

{
    "required":[
        "name",
        "type"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of argument"
        },
        "type":{
            "type":"string",
            "description":"Data type of argument or name of schema (if not primitive)"
        },
        "schemaRef":{
            "type":"string",
            "description":"Schema link if data type is complex"
        },
        "schemaDefinition":{
            "type":"string",
            "description":"Schema definition"
        }
    }
}

401 Response

Unauthorized

404 Response

Process interface with given ID does not exist.

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

520 Response

Server-side Processing 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