Skip to main content

 

 

Coupa Success Portal

Task API (/tasks)

Overview

The Task API lets you perform standard GET, PUT, POST, and DELETE actions. You can also access Tasks associated with Projects or Groups through their own endpoints: /projects/{project_id}/tasks and /user_groups/{user_group_id}/tasks.

See Integration Best Practices for more info.

Actions

The Task API allows you to:

Verb Path Action Description
POST /api/user_groups/:user_group_id/tasks create /api/user_groups/:user_group_id/tasks
POST /api/projects/:project_id/tasks create /api/projects/:project_id/tasks
POST /api/tasks create /api/tasks
DELETE /api/projects/:project_id/tasks/:id destroy /api/projects/:project_id/tasks/:id
DELETE /api/tasks/:id destroy /api/tasks/:id
GET /api/user_groups/:user_group_id/tasks index /api/user_groups/:user_group_id/tasks
GET /api/projects/:project_id/tasks index /api/projects/:project_id/tasks
GET /api/tasks index /api/tasks
GET /api/user_groups/:user_group_id/tasks/:id show /api/user_groups/:user_group_id/tasks/:id
GET /api/projects/:project_id/tasks/:id show /api/projects/:project_id/tasks/:id
GET /api/tasks/:id show /api/tasks/:id
PATCH /api/user_groups/:user_group_id/tasks/:id update /api/user_groups/:user_group_id/tasks/:id
PUT /api/user_groups/:user_group_id/tasks/:id update /api/user_groups/:user_group_id/tasks/:id
PATCH /api/projects/:project_id/tasks/:id update /api/projects/:project_id/tasks/:id
PUT /api/projects/:project_id/tasks/:id update /api/projects/:project_id/tasks/:id
PATCH /api/tasks/:id update /api/tasks/:id
PUT /api/tasks/:id update /api/tasks/:id

Elements

The following elements are available for the Users API:

Element Description Required Field? Unique? Allowable Value Api_In Field? Api_Out Field? Data Type
account-groups account_groups       yes yes Account Group 
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User 
description description       yes yes text
due-date due date       yes yes datetime
duration duration       yes yes float
id Coupa unique identifier         yes integer
linkable Association to which the task is linked to. Possible values are UserGroup/Project yes       yes Task
linkable-id Id of the User group or Project that the task is linked to       yes yes integer
linkable-type linked object type.Task cn be linked to User group or a Project       yes yes string(255)
owner Owner yes       yes User 
owner-id User id to whom the task is assigned       yes yes integer
percentage percentage     0 to 100 yes yes integer
resolved-at Timestamp the task was resolved in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
resolved-by User who resolved the task         yes User 
start-date start date       yes yes datetime
status status of task       yes yes string(255)
title title yes     yes yes string(255)
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User 

 

  • Was this article helpful?