/api/Job/Job/{id}
Get
Summary:
Returns a Job corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Job. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The JobGroup. | Job |
Put
Summary:
Updates a Job.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Job to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Job update. | JobUpdatedResult |
Delete
Summary:
Deletes a Job.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Job to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Job delete. | JobDeletedResult |
/api/Job/Job
Post
Summary:
Creates a Job.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the JobGroup creation. | JobCreatedResult |
Get
Summary:
Returns all the Job according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The JobGroup list. | List of Job |
/api/Job/Job/Notification
Put
Summary:
Send Job Notification.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the job notification. | SendJobNotificationResult |
/api/Job/JobInstance
Get
Summary:
Returns all the job instance according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The job instance list. | List of JobInstance |
Post
Summary:
Creates a job instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the job instance creation. | JobInstanceCreatedResult |
/api/Job/JobInstance/{id}
Put
Summary:
Updates a job instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the job instance to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the job instance update. | JobInstanceUpdatedResult |
Delete
Summary:
Deletes a job instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the job instance to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the job instance delete. | JobInstanceDeletedResult |
Get
Summary:
Returns a job instance corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the job instance. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The job instance. | JobInstance |
/api/Job/JobStep
Get
Summary:
Returns all the JobSteps according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The JobStep list. | List of JobStep |
Post
Summary:
Creates a JobStep.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the JobStep creation. | JobStepCreatedResult |
/api/Job/JobStep/{id}
Get
Summary:
Returns a JobStep corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the JobStep. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The JobStep. | JobStep |
Put
Summary:
Updates a JobStep.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of JobStep to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the JobStep update. | JobStepUpdatedResult |
Delete
Summary:
Deletes a JobStep.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the JobStep to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the JobStep delete. | JobStepDeletedResult |
/api/Job/Task
Get
Summary:
Returns all the Tasks according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The job list. | List of JTask |
Post
Summary:
Creates a Task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Task creation. | TaskCreatedResult |
/api/Job/Task/{id}
Get
Summary:
Returns a Task corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Task. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The Task. | JTask |
Put
Summary:
Updates a Task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Task to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Task update. | TaskUpdatedResult |
Delete
Summary:
Deletes a Task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Task to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Task delete. | TaskDeletedResult |
/api/Job/TaskDependOnTask
Get
Summary:
Returns all the DependOnTask's task according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The DependOnTask's task list. | List of TaskDependOnTask |
Post
Summary:
Creates a DependOnTask's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the DependOnTask's task creation. | TaskDependOnTaskCreatedResult |
/api/Job/TaskDependOnTask/{id}
Get
Summary:
Returns a DependOnTask's task corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the DependOnTask's task. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The DependOnTask's task. | TaskDependOnTask |
Put
Summary:
Updates a DependOnTask's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the DependOnTask's task to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the DependOnTask's task update. | TaskDependOnTaskUpdatedResult |
Delete
Summary:
Deletes a DependOnTask's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the DependOnTask's task to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the DependOnTask's task delete. | TaskDependOnTaskDeletedResult |
/api/Job/TaskDimension
Get
Summary:
Returns all the Dimension's task according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The single role list. | List of TaskDimension |
Post
Summary:
Creates a Dimension's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Dimension's task creation. | TaskDimensionCreatedResult |
/api/Job/TaskDimension/{id}
Get
Summary:
Returns a Dimension's task corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Dimension's task. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The Dimension's task. | TaskDimension |
Put
Summary:
Updates a Dimension's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Dimension's task to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Dimension's task update. | TaskDimensionUpdatedResult |
Delete
Summary:
Deletes a Dimension's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the Dimension's task to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the Dimension's task delete. | TaskDimensionDeletedResult |
/api/Job/TaskEntityType
Get
Summary:
Returns all the EntityType's task according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The EntityType's task list. | List of TaskEntityType |
Post
Summary:
Creates an EntityType's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the EntityType's task creation. | TaskEntityTypeCreatedResult |
/api/Job/TaskEntityType/{id}
Get
Summary:
Returns an EntityType's task corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the EntityType's task. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The EntityType's task. | TaskEntityType |
Put
Summary:
Updates an EntityType's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the EntityType's task to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the EntityType's task update. | TaskEntityTypeUpdatedResult |
Delete
Summary:
Deletes an EntityType's task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the EntityType's task to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the EntityType's task delete. | TaskEntityTypeDeletedResult |
/api/Job/TaskInstance
Get
Summary:
Returns all the task instance according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The task instance list. | List of TaskInstance |
Post
Summary:
Creates a task instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the task instance creation. | TaskInstanceCreatedResult |
/api/Job/TaskInstance/{id}
Get
Summary:
Returns a task instance corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the task instance. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The task instance. | TaskInstance |
Put
Summary:
Updates a task instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the task instance to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the task instance update. | TaskInstanceUpdatedResult |
Delete
Summary:
Deletes a task instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the task instance to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the task instance delete. | TaskInstanceDeletedResult |
/api/Job/TaskResourceType
Get
Summary:
Returns all the ResourceType's Task according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The ResourceType's Task list. | List of TaskResourceType |
Post
Summary:
Creates a ResourceType's Task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the ResourceType's Task creation. | TaskResourceTypeCreatedResult |
/api/Job/TaskResourceType/{id}
Get
Summary:
Returns a ResourceType's Task corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the ResourceType's Task. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The ResourceType's Task. | TaskResourceType |
Put
Summary:
Updates a ResourceType's Task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the ResourceType's Task to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the ResourceType's Task update. | TaskResourceTypeUpdatedResult |
Delete
Summary:
Deletes a ResourceType's Task.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the ResourceType's Task to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the ResourceType's Task delete. | TaskResourceTypeDeletedResult |