Updates Workflow Definition metadata and replaces its Subject while unlocked.

PUT

/api/workspace/workflow/configuration/workflow-definitions/{workflowDefinitionId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/workflow/configuration/workflow-definitions/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"ExpectedRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"OperationId\": \"example\", \"NumberPrefix\": \"example\", \"CollaborationPolicy\": 0, \"Subject\": null }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/workflow/configuration/workflow-definitions/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Key":"example","DisplayName":"example","Description":"example","ExpectedRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","OperationId":"example","NumberPrefix":"example","CollaborationPolicy":0,"Subject":null}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/workflow/configuration/workflow-definitions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example", "NumberPrefix": "example", "CollaborationPolicy": 0, "Subject": null }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

workflowDefinitionId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

object

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

ExpectedRowVersion

string format: uuid

OperationId

string

nullable

NumberPrefix

string

nullable

CollaborationPolicy

integer format: int32

Allowed values: 0 1

Subject

Any of:

object
object

object

Kind

integer format: int32

Allowed values: 0 1

EntityDefinitionId

string

nullable

BoardId

string

nullable

Responses

200

application/json

object

Data

object

WorkflowDefinition

object

WorkflowDefinitionId

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

CreatedAtUtc

string format: date-time

ModifiedAtUtc

string format: date-time

nullable

CreatedByUserId

string

nullable

ModifiedByUserId

string

nullable

RowVersion

string format: uuid

Actions

object

CanRead

boolean

CanUpdate

boolean

CanDelete

boolean

CanEditSubject

boolean

NumberPrefix

string

nullable

Subject

Any of:

object
object

object

Contract

object

Kind

integer format: int32

Allowed values: 0 1

EntityDefinitionId

string

nullable

BoardId

string

nullable

EntityDefinitionName

string

nullable

BoardName

string

nullable

IsAvailable

boolean

UnavailableReason

string

nullable

CollaborationPolicy

integer format: int32

Allowed values: 0 1

Replayed

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "WorkflowDefinition": {
      "Subject": null,
      "CollaborationPolicy": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}