Task groups¶
Task groups can be used to control the resources that a specific job should use.
New in version 4.4.
Task groups¶
Retrieve task groups¶
-
GET
/task-group
¶ Retrieves all task groups that have been defined in the system.
Produces: - application/xml, application/json – TaskGroupListDocument
Role: _administrator
Create or update task group¶
-
PUT
/task-group/
(group-name)¶ Creates or updates the task group with the given name.
Accepts: - application/xml, application/json – TaskGroupDocument
Produces: - application/xml, application/json – TaskGroupDocument
Role: _administrator
Example¶
PUT /task-group/imports HTTP/1.1
Accept: application/xml
Content-Type: application/xml
<TaskGroupDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<job>
<type>PLACEHOLDER_IMPORT</type>
</job>
<transcoder>
<id>VX-1</id>
</transcoder>
</TaskGroupDocument>
<TaskGroupDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<name>imports</name>
<job>
<type>PLACEHOLDER_IMPORT</type>
</job>
<transcoder>
<id>VX-1</id>
</transcoder>
</TaskGroupDocument>
Create or update task group¶
-
PUT
/task-group/
(group-name)¶ Creates or updates the task group with the given name.
This request is identical to the above, except that the task group parameters are specified using query parameters instead of using a TaskGroupDocument.
Query Parameters: - priority – The priority of the task group.
- transcoder – The id of the transcoder(s) to include in the group.
- job –
The job criteria(s). One of:
type:{type}
- Jobs of this type.priority:{priority}
- Jobs with this priority.user:{username}
- Jobs created by this user.group:{groupname}
- Jobs created by a user in this group.data:{key}[={value}]
- Jobs with this job data.
- metadata – Any key-value metadata to set on the group. Format is
{key}={value}
.
Produces: - application/xml, application/json – TaskGroupDocument
Role: _administrator
Example¶
PUT /task-group/imports?job=type:PLACEHOLDER_IMPORT&transcoder=VX-1 HTTP/1.1
Accept: application/xml
<TaskGroupDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<name>imports</name>
<job>
<type>PLACEHOLDER_IMPORT</type>
</job>
<transcoder>
<id>VX-1</id>
</transcoder>
</TaskGroupDocument>
Retrieve a task group¶
-
GET
/task-group/
(group-name)¶ Retrieves the task group document for a task group with a specific name.
Produces: - application/xml, application/json – TaskGroupDocument
Role: _administrator
Task group transcoders¶
Key-value metadata¶
Task groups support key-value metadata.