Skip to content
MoltaroMoltaroMoltaro Docs

Admits one definition as a future Task Context source, without granting access to its data.

POST
/api/workspace/tasks/configuration/task-definitions/{taskDefinitionId}/context-definitions
curl --request POST \
  --url https://example.com/api/workspace/tasks/configuration/task-definitions/example/context-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ExpectedDefinitionRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
taskDefinitionId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Request Body

Section titled “Request Body”
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ExpectedDefinitionRowVersion
string format: uuid
OperationId
string
nullable
Examplegenerated
{
  "ModuleKey": "example",
  "ResourceKind": "example",
  "ContextResourceId": "example",
  "ExpectedDefinitionRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "OperationId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data
object
TaskDefinition
object
TaskDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
State
integer format: int32
Allowed values: 0 1
ExecutionMode
integer format: int32
Allowed values: 0 1
SubjectMode
integer format: int32
Allowed values: 0 1 2
DefaultPriority

Signed 64-bit integer (-9223372036854775808 through 9223372036854775807). Output is an exact decimal string; do not convert through floating point.

string
/^-?[0-9]{1,19}$/
InputDataEntityDefinitionId
string
nullable
WorkingDataEntityDefinitionId
string
nullable
CreatedAtUtc
string format: date-time
ModifiedAtUtc
string format: date-time
nullable
CreatedByUserId
string
nullable
ModifiedByUserId
string
nullable
RowVersion
string format: uuid
Outcomes
Array<object>
nullable
object
OutcomeId
string
nullable
Code
string
nullable
DisplayName
string
nullable
Description
string
nullable
MetaType
integer format: int32
Allowed values: 0 1 2
SortOrder
integer format: int32
IsActive
boolean
CreatedAtUtc
string format: date-time
ModifiedAtUtc
string format: date-time
nullable
RowVersion
string format: uuid
Actions
object
CanUpdate
boolean
CanDelete
boolean
CanManageCompletionEligibility
boolean
CanManageActorGrants
boolean
ActorGrants
Array<integer>
nullable
Allowed values: 0 1 2 3 4
CompletionEligibilityRules
Array<object>
nullable
object
RuleId
string
nullable
OutcomeId
string
nullable
Code
string
nullable
Expression
string
nullable
NormalizedExpression
string
nullable
DefaultMessage
string
nullable
MessageTranslations
object
key
additional properties
string
Enabled
boolean
SortOrder
integer format: int32
EngineVersion
string
nullable
ProfileVersion
integer format: int32
SchemaFingerprint
string
nullable
ProfileFingerprint
string
nullable
ExpressionFingerprint
string
nullable
ArtifactFingerprint
string
nullable
Diagnostics
Array<object>
nullable
object
Code
string
nullable
Message
string
nullable
Severity
string
nullable
Start
integer format: int32
nullable
Length
integer format: int32
nullable
DependencyId
string
nullable
Dependencies
Array<object>
nullable
object
Kind
integer format: int32
Allowed values: 0 1 2
DependencyId
string
nullable
Path
string
nullable
CollectionScope
string
nullable
CreatedAtUtc
string format: date-time
ModifiedAtUtc
string format: date-time
nullable
RowVersion
string format: uuid
Actions
object
CanUpdate
boolean
CanDelete
boolean
CanRead
boolean
InterruptionReasons
Array<object>
nullable
object
ReasonId
string
nullable
Code
string
nullable
DisplayName
string
nullable
Description
string
nullable
Kind
integer format: int32
Allowed values: 0 1 2
IsActive
boolean
SortOrder
integer format: int32
CreatedAtUtc
string format: date-time
ModifiedAtUtc
string format: date-time
nullable
RowVersion
string format: uuid
Actions
object
CanUpdate
boolean
CanDelete
boolean
ExecutionPolicy
object
ExecutionMode
integer format: int32
Allowed values: 0 1
QueueResponsibleRequired
boolean
PostponementEnabled
boolean
FixedPostponementDelayMinutes
integer format: int32
nullable
MaximumPostponementsPerTask
integer format: int32
nullable
PauseWarningAfterMinutes
integer format: int32
nullable
BlockedWarningAfterMinutes
integer format: int32
nullable
AvailableActors
Array<integer>
nullable
Allowed values: 0 1 2 3 4
OutcomeActorGrantDefaults
Array<object>
nullable
object
MetaType
integer format: int32
Allowed values: 0 1 2
ActorGrants
Array<integer>
nullable
Allowed values: 0 1 2 3 4
Diagnostics
Array<object>
nullable
object
Code
string
nullable
Message
string
nullable
Severity
string
nullable
Field
string
nullable
ResponsibleRequiredOnCreate
boolean
TransitionRules
Array<object>
nullable
object
RuleId
string
nullable
FromState
integer format: int32
Allowed values: 0 1 2 3 4 5
ToState
integer format: int32
Allowed values: 0 1 2 3 4 5
Supported
boolean
Enabled
boolean
ActorGrants
Array<integer>
nullable
Allowed values: 0 1 2 3 4
RowVersion
string format: uuid
Actions
object
CanUpdate
boolean
Actions
object
CanRead
boolean
CanUpdate
boolean
CanSetState
boolean
CanManageOutcomes
boolean
CanManageInterruptionReasons
boolean
CanManageExecutionPolicy
boolean
CanManageTransitions
boolean
CanDelete
boolean
CreationPolicy
object
DueDateMode
integer format: int32
Allowed values: 0 1 2
ContextRequired
boolean
ResponsibleRequiredOnCreate
boolean
AllowedContextDefinitions
Array<object>
nullable
object
AdmissionId
string
nullable
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
Key
string
nullable
DisplayName
string
nullable
IsAvailable
boolean
UnavailableReasonCode
string
nullable
RolesAssignments
object
RoleMappings
Array<object>
nullable
object
MappingId
string
nullable
WorkspaceRoleId
string
nullable
InternalRoleKey
string
nullable
RowVersion
string format: uuid
ParticipantAdmissions
Array<object>
nullable
object
AdmissionId
string
nullable
Participant
integer format: int32
Allowed values: 0 1 2
SourceKind
integer format: int32
Allowed values: 0 1
SourceId
string
nullable
Sources
Array<object>
nullable
object
SourceKind
integer format: int32
Allowed values: 0 1
Id
string
nullable
DisplayName
string
nullable
AssignmentPolicy
object
InitialOwner
required
integer format: int32
Allowed values: 0 1 2 4
InitialResponsible
required
integer format: int32
Allowed values: 0 1 2 4
ChangeOwner
required
integer format: int32
Allowed values: 0 1 2 4
ChangeResponsible
required
integer format: int32
Allowed values: 0 1 2 4
Permissions
required
object
Rules
Array<object>
nullable
object
Operation
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Grants
Array<object>
nullable
object
Actor
required
integer format: int32
Allowed values: 0 1 2 3 4 5
State
required
integer format: int32
Allowed values: 0 1 2 3 4 5
Collaboration
required
object
Enabled
required
boolean
Comments
object
ReadSources
required
integer format: int32
Allowed values: 0 1 2 4
Owner
required
integer format: int32
Allowed values: 0 1 2
PublishTo
required
integer format: int32
Allowed values: 0 1 2 4
Files
object
ReadSources
required
integer format: int32
Allowed values: 0 1 2 4
Owner
required
integer format: int32
Allowed values: 0 1 2
PublishTo
required
integer format: int32
Allowed values: 0 1 2 4
Rules
Array<object>
nullable
object
Operation
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Grants
Array<object>
nullable
object
Actor
required
integer format: int32
Allowed values: 0 1 2 3 4 5
State
required
integer format: int32
Allowed values: 0 1 2 3 4 5
Instructions
required
object
Enabled
required
boolean
Markdown
string
nullable
FileReferenceIds
Array<string>
nullable
NumberPrefix
string
nullable
SignalProfileId
string
nullable
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": {
    "TaskDefinition": {
      "State": 0,
      "ExecutionMode": 0,
      "SubjectMode": 0,
      "Outcomes": [
        {
          "MetaType": 0,
          "ActorGrants": [
            0
          ],
          "CompletionEligibilityRules": [
            {
              "Dependencies": [
                {
                  "Kind": 0
                }
              ]
            }
          ]
        }
      ],
      "InterruptionReasons": [
        {
          "Kind": 0
        }
      ],
      "ExecutionPolicy": {
        "ExecutionMode": 0,
        "AvailableActors": [
          0
        ],
        "OutcomeActorGrantDefaults": [
          {
            "MetaType": 0,
            "ActorGrants": [
              0
            ]
          }
        ]
      },
      "TransitionRules": [
        {
          "FromState": 0,
          "ToState": 0,
          "ActorGrants": [
            0
          ]
        }
      ],
      "CreationPolicy": {
        "DueDateMode": 0
      },
      "RolesAssignments": {
        "ParticipantAdmissions": [
          {
            "Participant": 0,
            "SourceKind": 0
          }
        ],
        "Sources": [
          {
            "SourceKind": 0
          }
        ],
        "AssignmentPolicy": {
          "InitialOwner": 0,
          "InitialResponsible": 0,
          "ChangeOwner": 0,
          "ChangeResponsible": 0
        }
      },
      "Permissions": {
        "Rules": [
          {
            "Operation": 0,
            "Grants": [
              {
                "Actor": 0,
                "State": 0
              }
            ]
          }
        ]
      },
      "Collaboration": {
        "Comments": {
          "ReadSources": 0,
          "Owner": 0,
          "PublishTo": 0
        },
        "Files": {
          "ReadSources": 0,
          "Owner": 0,
          "PublishTo": 0
        },
        "Rules": [
          {
            "Operation": 0,
            "Grants": [
              {
                "Actor": 0,
                "State": 0
              }
            ]
          }
        ]
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}