Project Template Assignments

Project Template Assignments(Project Template Resources) represent placeholders for task assignees in project templates. These assignments are mapped to project template stories and are assigned to real users when the template is applied.

Operations

Fetching a list of Project Template Assignments

Request

This endpoint returns structured Project Template Assignment objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the project_template_assignments top-level JSON key. Please see our Response Format section for more information.

Query

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

project_template (ProjectTemplate) - The project template associated with the assignment.
role (Role).

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"total_estimated_minutes""total_count""role_initials""role_name"

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: updated_at:asc and updated_at:desc.

Default:"updated_at:desc"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

project_template_idinteger, (int32)

Limits project template assignments to a specific project template.

GET

/project_template_assignments

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/project_template_assignments?include=string&only=string&optional_fields=total_estimated_minutes&order=updated_at%3Adesc&page=1&per_page=20&project_template_id=0'

Responses

A list of Project Template Assignments have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

project_template_assignmentsobject

project_templatesobject

rolesobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "project_template_assignments": {
    "property1": {
      "name": "string",
      "project_template_id": "string",
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "total_count": 0,
      "total_estimated_minutes": 0
    },
    "property2": {
      "name": "string",
      "project_template_id": "string",
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "total_count": 0,
      "total_estimated_minutes": 0
    }
  },
  "project_templates": {
    "property1": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  },
  "roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}