Jump to

• Request
• Response

Retrieve Document Metadata

get

/ic/api/process/v1/process-definitions/{processDefId}/documents

Retrieves the folders metadata information for a given process definition ID

Request

Path Parameters

• processDefId(required): string
  Value of process definition ID.

Query Parameters

• expanded: string
  Retrieves only the folder for the specified folder name

  Default Value: none

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Returns the documents.

Body ()

Root Schema : documents

Type: object

Show Source

• levels: integer(int32)
• links: array links
• title: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        }
    },
    "xml":{
        "name":"documents",
        "namespace":"http://xmlns.oracle.com/bpm/rest/process-definitions"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

500 Response

Error in retrieving the folder information

Back to Top