Updates workflow subscription

Updates workflow subscription

Updates workflow subscription

Request
URI
PUT
https://{api_host}/advanced-designer-service/api/event-broker/subscriptions/{subscriptionId}
COPY
Path Parameters
string
subscriptionId
Required

The id of the workflow subscription instance to update

Request Body

The new state of the workflow subscription

WorkflowSubscription of type(s) application/json
Required

Show optional properties

{
    "workflowId": "string",
    "status": "string"
}
{
    "criteria": {},
    "description": "string",
    "eventTopicId": "string",
    "priority": 0,
    "failOnError": false,
    "version": {
        "major": 0,
        "minor": 0,
        "micro": 0,
        "version": "string",
        "revision": 0
    },
    "timeout": 0,
    "blocking": false,
    "tenantId": "string",
    "name": "string",
    "statusName": "string",
    "id": "string",
    "reply": false,
    "workflowId": "string",
    "status": "string"
}
object
criteria
Optional

criteria

string
description
Optional
Constraints: minLength: 0 maxLength: 2000

description

string
eventTopicId
Optional

eventTopicId

integer As int32 As int32
priority
Optional
Constraints: minimum: 0

priority

boolean
failOnError
Optional

failOnError

object
version
Optional

version

integer As int32 As int32
timeout
Optional

timeout

boolean
blocking
Optional

blocking

string
tenantId
Optional
Constraints: minLength: 1 maxLength: 255

tenantId

string
name
Optional
Constraints: minLength: 0 maxLength: 255

name

string
statusName
Optional

statusName

string As uuid As uuid
id
Optional

id

boolean
reply
Optional

reply

string
workflowId
Required
Constraints: minLength: 0 maxLength: 255

workflowId

string
status
Required

status

Possible values are : DRAFT, PUBLISHED, RETIRED,
Responses
200

successful operation

Operation doesn't return any data structure

204
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"status:"string","workflowId:"string"}' https://{api_host}/advanced-designer-service/api/event-broker/subscriptions/{subscriptionId}
On This Page
Get Operation Operations
GET
Gets the workflow execution data
GET
Searches for ScriptActionSummary objects
GET
Get Blueprint
DELETE
Delete Blueprint
PUT
Update Blueprint
POST
Get the permissible values Of A field In the schema
GET
Retrieves A resource operation
DELETE
Delete Resource Operation
PUT
Update Resource Operation
GET
Gets A ValueDefinition
DELETE
Deletes A ValueDefinition
PUT
Updates Or creates A ValueDefinition
GET
Gets the workflow form
GET
Retrieves the ScriptActionSummary objects underneath A specified category.
GET
Gets A configuration
DELETE
Deletes A configuration
GET
Gets output fields Of A workflow
PUT
Tests default configuration for communication with VRO
PUT
Generates A resource opreation based On A workflow
GET
Retrieves all ScriptActionCategory categories
GET
Gets A form
DELETE
Deletes A form
PUT
Updates A form
POST
Retrieves the values behind the applicable ValueDefinition object for the given key
GET
Gets A workflow
GET
Gets A resource type Or resource mapping
DELETE
Delete Resource Type
POST
Retrieves the value behind the applicable {@link ValueDefinition} for the given key
PUT
Gets A details form
PUT
Tests provided configuration for communication with VRO
GET
Get Tags Of the Catalog Resource Item
GET
Generates A service blueprint based On A workflow
GET
Gets workflow fields
GET
Gets all inventory types matching the filtering criteria
GET
Gets all configurations
PUT
Creates Or updates configuration
GET
Gets workflow subscription By Id
DELETE
Deletes A workflow subscription
PUT
Updates workflow subscription
GET
Gets the count Of active resources