Jump to

• Request
• Response

Get Dynamic Process Definition Metadata

get

/ic/api/process/v1/dp-definitions/{id}/metadata

Get the metadata of the dynamic process definition with the specified process definition ID.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Process Definition ID.

Query Parameters

• type: string
  Metadata Type

  Default Value: all

  Allowed Values: [ "all", "dataObjects", "planItems", "documents" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ProcessDefinitionMetadata

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessDefinitionMetadata-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "processDefinitionId":{
                    "type":"string",
                    "description":"Process definition ID"
                },
                "dataObjects":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DataObjectMetadata"
                    }
                },
                "planItems":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/PlanItemMetadata"
                    }
                },
                "documents":{
                    "$ref":"#/definitions/DocumentsDefinition"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links: array links

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

Nested Schema : ProcessDefinitionMetadata-allOf[1]

Type: object

Show Source

• dataObjects: array dataObjects
• documents: object DocumentsDefinition
  Documents definition
• planItems: array planItems
• processDefinitionId: string
  Process definition ID

{
    "properties":{
        "processDefinitionId":{
            "type":"string",
            "description":"Process definition ID"
        },
        "dataObjects":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataObjectMetadata"
            }
        },
        "planItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PlanItemMetadata"
            }
        },
        "documents":{
            "$ref":"#/definitions/DocumentsDefinition"
        }
    }
}

Nested Schema : dataObjects

Type: array

Show Source

• Array of: object DataObjectMetadata

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataObjectMetadata"
    }
}

Nested Schema : DocumentsDefinition

Type: object

Documents definition

Show Source

• documentDefinitions: array documentDefinitions
• isDocsEnabledFlag: boolean
  if DoCS is enabled this will be true.

{
    "description":"Documents definition",
    "properties":{
        "isDocsEnabledFlag":{
            "type":"boolean",
            "description":"if DoCS is enabled this will be true."
        },
        "documentDefinitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentDefinition"
            }
        }
    }
}

Nested Schema : planItems

Type: array

Show Source

• Array of: object PlanItemMetadata
  A Plan Item object

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PlanItemMetadata"
    }
}

Nested Schema : DataObjectMetadata

Type: object

Show Source

• columns: array columns
• displayName: string
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "columns":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Column"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"DataObjectMetadata",
        "namespace":"http://xmlns.oracle.com/bpm/rest/DataObjectMetadata"
    }
}

Nested Schema : columns

Type: array

Show Source

• Array of: object Column

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Column"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Column

Type: object

Show Source

• dataType: string
  Allowed Values: [ "STRING", "INTEGER", "DECIMAL", "BOOLEAN", "TIME" ]
• entityAttributes: array entityAttributes
• key: boolean
• name: string
• size: integer(int32)
• transientAttributes: object transientAttributes
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string",
            "enum":[
                "STRING",
                "INTEGER",
                "DECIMAL",
                "BOOLEAN",
                "TIME"
            ]
        },
        "key":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "size":{
            "type":"integer",
            "format":"int32"
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AttrObject"
    }
}

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : AttrObject

Type: object

Show Source

• attrType: string
  Allowed Values: [ "VALUE", "REF" ]
• contentType: string
  Allowed Values: [ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
• defaultValue: object defaultValue
• id: string
• msg: object Msg

{
    "type":"object",
    "properties":{
        "msg":{
            "$ref":"#/definitions/Msg"
        },
        "attrType":{
            "type":"string",
            "enum":[
                "VALUE",
                "REF"
            ]
        },
        "contentType":{
            "type":"string",
            "enum":[
                "OBJECT",
                "NATIVE_OBJECT",
                "LIST",
                "SORTED_LIST",
                "MAP"
            ]
        },
        "id":{
            "type":"string"
        },
        "defaultValue":{
            "type":"object"
        }
    }
}

Nested Schema : defaultValue

Type: object

Nested Schema : Msg

Type: object

Show Source

• allAvailableTranslationsForProjectLanguages: object allAvailableTranslationsForProjectLanguages
  Additional Properties Allowed: additionalProperties
• argCount: integer(int32)
• bundleName: string
• bundleShortName: string
• code: string
• detail: string
• imageFile: string
• imageResource: string(url)
• localizedLogMessage: string
• logComponent: string
  Allowed Values: [ "DEFAULT" ]
• mnemonic: string
• nonLocalizedString: string
• string: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "logComponent":{
            "type":"string",
            "enum":[
                "DEFAULT"
            ]
        },
        "argCount":{
            "type":"integer",
            "format":"int32"
        },
        "string":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "allAvailableTranslationsForProjectLanguages":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "mnemonic":{
            "type":"string"
        },
        "localizedLogMessage":{
            "type":"string"
        },
        "imageFile":{
            "type":"string"
        },
        "imageResource":{
            "type":"string",
            "format":"url"
        },
        "nonLocalizedString":{
            "type":"string"
        },
        "bundleShortName":{
            "type":"string"
        },
        "bundleName":{
            "type":"string"
        }
    }
}

Nested Schema : allAvailableTranslationsForProjectLanguages

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

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

Nested Schema : documentDefinitions

Type: array

Show Source

• Array of: object DocumentDefinition
  Document defintion

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DocumentDefinition"
    }
}

Nested Schema : DocumentDefinition

Type: object

Document defintion

Show Source

• name: string
  Display Name
• startupFlag: boolean
  true if it is a startup managed-folder
• type: string
  Allowed Values: [ "MANAGED_FOLDER", "INCOMING_FOLDER", "INCOMING_DOCUMENT" ]

  Document defintion type

{
    "description":"Document defintion",
    "properties":{
        "name":{
            "type":"string",
            "description":"Display Name"
        },
        "type":{
            "type":"string",
            "description":"Document defintion type",
            "enum":[
                "MANAGED_FOLDER",
                "INCOMING_FOLDER",
                "INCOMING_DOCUMENT"
            ]
        },
        "startupFlag":{
            "type":"boolean",
            "description":"true if it is a startup managed-folder"
        }
    }
}

Nested Schema : PlanItemMetadata

Type: object

A Plan Item object

Show Source

• childPlanItems: array childPlanItems
• displayName: string
  Display name of the resource
• id: string
  ID of the resource

{
    "description":"A Plan Item object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the resource"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the resource"
        },
        "childPlanItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PlanItemMetadata"
            }
        }
    }
}

Nested Schema : childPlanItems

Type: array

Show Source

• Array of: object PlanItemMetadata
  A Plan Item object

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PlanItemMetadata"
    }
}

401 Response

Unauthorized

404 Response

A dynamic process definition with the specified ID or key does not exist.

500 Response

Internal Server Error

Back to Top