Jump to

• Request
• Response

Get a Process Resource by Name

get

/process/api/v1/dp-resources/{name}

Retrieves the process resource for a given resource name and deployment ID.

Request

Path Parameters

• name(required): string
  Process Resource name

Query Parameters

• applicationName: string
  Application name for a resource
• applicationVersion: string
  Application version for a resource
• deploymentId: string
  Application name for a resource

Header Parameters

• 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 : ProcessResources

Type: object

Match All

Show Source

• object CommonModel
• object ProcessResources-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProcessResource"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : ProcessResources-allOf[1]

Type: object

Show Source

• items: array items

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

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 ProcessResource

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

Nested Schema : ProcessResource

Type: object

Match All

Show Source

• object CommonModel
• object ProcessResource-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the deployment resource."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the deployment resource."
                },
                "schema":{
                    "type":"object",
                    "description":"The schema of the resource."
                }
            }
        }
    ]
}

Nested Schema : ProcessResource-allOf[1]

Type: object

Show Source

• id: string
  The ID of the deployment resource.
• name: string
  The name of the deployment resource.
• schema: object schema
  The schema of the resource.

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the deployment resource."
        },
        "name":{
            "type":"string",
            "description":"The name of the deployment resource."
        },
        "schema":{
            "type":"object",
            "description":"The schema of the resource."
        }
    }
}

Nested Schema : schema

Type: object

The schema of the resource.

401 Response

Unauthorized

404 Response

Process resource with given resource name and deployment ID does not exist.

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top