Action

Overview

This document outlines the attributes of an action object within Action Tracker. Each action represents a task or activity that needs to be tracked and managed.

Attributes

Attribute	Type	Required	Queryable	Default	Examples	Description
id	string	Yes	No		"53bf5e949af0728372729857"	The unique identifier of an action.
title	string	Yes	Yes		"Fix the broken window"	A simple, descriptive title for an action.
description	string	No	No	null	"The window in the kitchen is broken. It needs to be fixed as soon as possible."	An extended description for an action.
actionProducer	object	Yes	Yes			An object representing the producer of the action.
location	object	Yes	Yes			An object representing the location related to the action.
dueAt	string	Yes	Yes		"2023-10-12T01:49:42.000Z"	The timestamp on which an action is due. ISO-8601 format.
priority	string	No	Yes	1		The current priority of an action.
status	string	No	Yes	0		The current status of an action.
initiator	string	No	No			An object representing the user who initiated the action.
owner	string	No	Yes			An object representing the owner of the action.
assignee	string	No	Yes			An object representing the user assigned to the action.
endorsedBy	string	No	No			An array representing entities that endorsed the action.
attachments	array	No	No			An array representing files attached to the action.
comments	array	No	No			An array representing comments made on the action.
tags	array	No	Yes			An array representing tags associated with the action.
meta	object	No	No			An object representing additional metadata for the action.
createdAt	string	No	Yes		"2023-10-12T01:49:42.000Z"	The timestamp on which an action was created. ISO-8601 format.
updatedAt	string	No	No		"2023-10-12T01:49:42.000Z"	The timestamp on which an action was last updated. ISO-8601 format.

JSON representation

Here is a JSON representation of the actions resource.

{
  "id": "string",
  "title": "string",
  "description": "string",
  "actionProducer": {
    "name": "string",
    "url": "string",
    "reference": "string"
  },
  "location": {
    "businessUnit": "string",
    "site": "string",
    "department": "string",
    "workGroup": "string",
    "productiveUnit": "string",
    "team": "string",
    "crew": "string"
  },
  "dueAt": "string",
  "owner": "string",
  "assignee": "string",
  "priority": "string",
  "status": "string",
  "initiator": "string",
  "endorsedBy": "string",
  "attachments": "string[]",
  "comments": "[]",
  "tags": "string[]",
  "meta": {}
}

Overview Post Action