Jump to

• Request
• Response

List Process Instance Documents

get

/process/api/v1/instances/{id}/documents

List documents associated with the process instance ID.

Request

Path Parameters

• id(required): string
  Instance ID

Query Parameters

• view: string
  View type of the documents

  Allowed Values: [ "flat", "hierarchy" ]

Header Parameters

• oci-original-url:
  Endpoint requested by customer

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : DocumentCollection

Match All

Show Source

• object CommonModel
• object DocumentCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ContentItem"
                    }
                },
                "taskId":{
                    "type":"string"
                },
                "processInstanceId":{
                    "type":"string"
                },
                "dpInstanceId":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : DocumentCollection-allOf[1]

Type: object

Show Source

• dpInstanceId: string
• items: array items
• processInstanceId: string
• taskId: string

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentItem"
            }
        },
        "taskId":{
            "type":"string"
        },
        "processInstanceId":{
            "type":"string"
        },
        "dpInstanceId":{
            "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
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ContentItem

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

Nested Schema : ContentItem

Type: object

Show Source

• contentType: string
• createdBy: User
• createdDate: string (date)
• description: string
• fileName: string
• href: string
• id: string
• lastUpdatedBy: User
• lastUpdatedDate: string (date)
• name: string
• parentFolderId: string
• permissions: array permissions
• type: string
• url: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "parentFolderId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "contentType":{
            "type":"string"
        },
        "createdBy":{
            "$ref":"#/components/schemas/User"
        },
        "createdDate":{
            "type":"string",
            "format":"date"
        },
        "lastUpdatedBy":{
            "$ref":"#/components/schemas/User"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date"
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : User

Match All

Show Source

• object IdentityCommon

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        }
    ]
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : IdentityCommon

Type: object

Show Source

• displayName: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "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"
        }
    }
}

Examples

Select an example Unauthorized error

500 Response

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

Examples

Select an example Internal error

Back to Top