Update contract state

PUT 
/api/v2/Contracts/States/:key

Update contract state

Request

Path Parameters

key stringrequired

Guid or ExternalKey

application/json

Body

required

Name stringrequired

Possible values: non-empty and <= 100 characters

DisplayName stringrequired

Possible values: non-empty and <= 100 characters

Visibility object

oneOf

ContractStateVisibility

string

Possible values: [Contracts, Subcontracts, All]

Color stringnullable

Possible values: <= 7 characters

SortOrder int32required

Possible values: >= 1 and <= 32767

ExternalKey stringnullable

Responses

200

Successfully Updated

application/json

Schema

Schema

Guid guidnullable

Example (from schema)

{
  "Guid": "string"
}

400

Error

application/json

Schema

Schema

Error objectrequired
Code stringnullable
Message stringnullable

Example (from schema)

{
  "Error": {
    "Code": "string",
    "Message": "string"
  }
}

404

Not Found

Loading...