Jump to

• Request
• Response

Update Data Object of Instance

put

/process/api/v1/instances/{id}/data-objects/{name}

Update data objects of a process instance using instance ID.

Request

Path Parameters

• id(required): string
  Process Instance Id
• name(required): string
  Data Object Name

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Endpoint requested by customer.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• value: string

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Match All

Show Source

• object CommonModel

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "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 : 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
        }
    }
}

Examples

Select an example Update dataobject value

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• value: string

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Match All

Show Source

• object CommonModel

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "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 : 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
        }
    }
}

401 Response

Unauthorized

404 Response

Process instance 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

Back to Top