Updates a TaskDefinition by id

put https://yourorgsite.com/api/TaskDefinition/{TaskDefinitionId}

Updates an instance of TaskDefinition by id

Path Params

TaskDefinitionId

string

required

Id of TaskDefinition to be Updated

Body Params

TaskDefinition to be Updated

$type

string

required

Defaults to Asi.Soa.Communications.DataContracts.TaskDefinitionData, Asi.Contracts

The DataType must be "Asi.Soa.Communications.DataContracts.TaskDefinitionData, Asi.Contracts"

Actions

object

Class taskdefinitionactiondatacollection.

DataSources

object

A collection of

Description

string

Gets or sets the task description.

Evaluations

object

Class that specifies a task definition evaluation collection.

IsActive

boolean

Defaults to false

Gets or sets a value indicating whether this task is active.

IsSystem

boolean

Defaults to false

Gets or sets a value indicating whether this task is system.

Name

string

Gets or sets the task name.

Notifications

object

Class that specifies a notification definition collection.

Priority

int32

Gets or sets the task priority.

SatisfyAllEvaluations

boolean

Defaults to false

Gets or sets a value indicating whether all evaluations must be satisfied.

TaskDefinitionId

string

Gets or sets the task definition identifier.

TaskType

string

Defaults to AlertDisplay

Enum used for the task type

Triggers

object

Class that specifies a task definition trigger collection.

UpdateInformation

object

Entity update information datacontract. Describe standard set of updated information.

Response

200

The request was successful.

Language

Credentials

OAuth2


xxxxxxxxxx
32
1
const options = {
2
  method: 'PUT',
3
  headers: {'content-type': 'application/json'},
4
  body: JSON.stringify({
5
    $type: 'Asi.Soa.Communications.DataContracts.TaskDefinitionData, Asi.Contracts',
6
    Actions: {
7
      $type: 'Asi.Soa.Communications.DataContracts.TaskDefinitionActionDataCollection, Asi.Contracts'
8
    },
9
    DataSources: {
10
      $type: 'Asi.Soa.Communications.DataContracts.DataSourceDataCollection, Asi.Contracts'
11
    },
12
    Evaluations: {
13
      $type: 'Asi.Soa.Communications.DataContracts.TaskDefinitionEvaluationDataCollection, Asi.Contracts'
14
    },
15
    IsActive: false,
16
    IsSystem: false,
17
    Notifications: {
18
      $type: 'Asi.Soa.Communications.DataContracts.NotificationDefinitionDataCollection, Asi.Contracts'
19
    },
20
    SatisfyAllEvaluations: false,
21
    TaskType: 'AlertDisplay',
22
    Triggers: {
23
      $type: 'Asi.Soa.Communications.DataContracts.TaskDefinitionTriggerDataCollection, Asi.Contracts'
24
    },
25
    UpdateInformation: {$type: 'Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts'}
26
  })
27
};
28
29
fetch('https://yourorgsite.com/api/TaskDefinition/TaskDefinitionId', options)

Click Try It! to start a request and see the response here!