Task
URL
https://api.primatime.com/v1/time/tasks
https://api.primatime.com/v1/time/tasks/@trackable
https://api.primatime.com/v1/time/tasks/@editable
https://api.primatime.com/v1/time/projects/{id}/tasks
https://api.primatime.com/v1/time/projects/{id}/tasks/@trackable
https://api.primatime.com/v1/time/projects/{id}/tasks/@editable
Properties
Name |
Type |
Access |
Required |
Description |
author |
User |
read write |
no |
User who created the task. |
code |
String |
read write |
no |
A code or an abbreviation of the task. |
createdAt |
Date |
read only |
no |
Date of creation. |
displayName |
String |
read only |
no |
Describes an object in human readable form. |
done |
Boolean |
read write |
no |
Determines whether the task is currently done. |
effective |
Boolean |
read write |
YES |
Determines whether the task is effective. Default value is true. |
externalBrowsableUrl |
String |
read write |
no |
Human accessible link in external system. |
externalResourceId |
String |
read write |
no |
Unique external system identifier. |
externalSynced |
Boolean |
write only |
no |
Determines whether an object was synced with the external system. |
externalSyncedAt |
Date |
read only |
no |
Date of the last sync with the external system. It is set when the 'externalSynced' flag is true. |
externalSystem |
ExternalSystem |
read write |
no |
External system which maintains this object. |
id |
String |
read write |
no |
Unique object identifier. |
name |
String |
read write |
no |
Task name. |
note |
String |
read write |
no |
Additional note. |
owner |
User |
read write |
no |
User who is responsible for the task. |
priceBudget |
Double |
read write |
no |
Amount of money available for the task. |
project |
Project |
read write |
no |
Tasks belonging to this project. |
timeBudget |
Long |
read write |
no |
Amount of milliseconds available for the task. |
trashItem |
TrashItem |
read write |
no |
Informs whether an object is in the trash. An object is in the trash if a trash item was specified. |
updatedAt |
Date |
read only |
no |
Last modified date. |
version |
Long |
read write |
no |
Object version number. |
{
"type" : "Task",
"path" : "/v1/time/tasks",
"fields" : [
{
"type" : "User",
"path" : "/v1/users",
"name" : "author",
"description" : "User who created the task.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "code",
"description" : "A code or an abbreviation of the task.",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "Size",
"details" : "min 0, max 20"
}
]
},
{
"type" : "Date",
"name" : "createdAt",
"description" : "Date of creation.",
"access" : "READ_ONLY"
},
{
"type" : "String",
"name" : "displayName",
"description" : "Describes an object in human readable form.",
"access" : "READ_ONLY"
},
{
"type" : "Boolean",
"name" : "done",
"description" : "Determines whether the task is currently done.",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "effective",
"description" : "Determines whether the task is effective.",
"defaultValue" : "true",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "NotNull"
}
]
},
{
"type" : "String",
"name" : "externalBrowsableUrl",
"description" : "Human accessible link in external system.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "externalResourceId",
"description" : "Unique external system identifier.",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "externalSynced",
"description" : "Determines whether an object was synced with the external system.",
"access" : "WRITE_ONLY"
},
{
"type" : "Date",
"name" : "externalSyncedAt",
"description" : "Date of the last sync with the external system. It is set when the 'externalSynced' flag is true.",
"access" : "READ_ONLY"
},
{
"type" : "ExternalSystem",
"path" : "/v1/externalsystems",
"name" : "externalSystem",
"description" : "External system which maintains this object.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "id",
"description" : "Unique object identifier.",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "Pattern",
"details" : "regexp [0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}"
},
{
"type" : "NotNull"
}
]
},
{
"type" : "String",
"name" : "name",
"description" : "Task name.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "note",
"description" : "Additional note.",
"access" : "READ_WRITE"
},
{
"type" : "User",
"path" : "/v1/users",
"name" : "owner",
"description" : "User who is responsible for the task.",
"access" : "READ_WRITE"
},
{
"type" : "Double",
"name" : "priceBudget",
"description" : "Amount of money available for the task.",
"access" : "READ_WRITE"
},
{
"type" : "Project",
"path" : "/v1/time/projects",
"name" : "project",
"description" : "Tasks belonging to this project.",
"access" : "READ_WRITE"
},
{
"type" : "Long",
"name" : "timeBudget",
"description" : "Amount of milliseconds available for the task.",
"access" : "READ_WRITE"
},
{
"type" : "TrashItem",
"path" : "/v1/trash",
"name" : "trashItem",
"description" : "Informs whether an object is in the trash. An object is in the trash if a trash item was specified.",
"access" : "READ_WRITE"
},
{
"type" : "Date",
"name" : "updatedAt",
"description" : "Last modified date.",
"access" : "READ_ONLY"
},
{
"type" : "Long",
"name" : "version",
"description" : "Object version number.",
"access" : "READ_WRITE"
}
],
"cascades" : [
{
"cascadeType" : "REMOVE",
"objectTypes" : [
"TrashItem"
]
}
]
}
Dummy data
{
"id" : "c18b08fc-49a4-4f42-a73c-60d026281709",
"createdAt" : "/Date(1651047086873)/",
"updatedAt" : "/Date(1651126106873)/",
"version" : 2,
"externalSystem" : {
"id" : "43a388fc-3e31-401e-a757-9f5dac4ba2b3",
"createdAt" : "/Date(1651047206873)/",
"updatedAt" : "/Date(1651118906873)/",
"version" : 3,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "task-556",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221/tasks/556",
"externalSyncedAt" : "/Date(1651050506872)/",
"externalSynced" : true,
"project" : {
"id" : "29194451-c3f7-47de-9eb5-9c2d60498bcf",
"createdAt" : "/Date(1651049066873)/",
"updatedAt" : "/Date(1651115306873)/",
"version" : 8,
"externalSystem" : {
"id" : "ab970afa-22c5-4a4a-b9b4-c2513967e6ab",
"createdAt" : "/Date(1651047026873)/",
"updatedAt" : "/Date(1651115306873)/",
"version" : 0,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "project-221",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221",
"externalSyncedAt" : "/Date(1651050506872)/",
"externalSynced" : true,
"name" : "Content management system",
"code" : "CMS",
"note" : "core feature",
"begins" : "/Date(1650964106872)/",
"ends" : "/Date(1651136906872)/",
"timeBudget" : 604800000,
"priceBudget" : 100000.0,
"personal" : false,
"owner" : {
"id" : "2d333e9f-893d-4d6a-bd11-10280c379d65",
"createdAt" : "/Date(1651050206873)/",
"updatedAt" : "/Date(1651118906873)/",
"version" : 6,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "qa30srs_fbzfvhu@testdata.com",
"phone" : "55 234 555 678",
"position" : "Senior developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "yyyy-MM-dd",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "pt_BR",
"password" : "npfxyz11_xhs2qp01u4k",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1652911200000)/",
"workingTimeStart" : "/Date(1651039200000)/",
"workingTimeEnd" : "/Date(1651071600000)/",
"created" : "/Date(1650964106872)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"client" : {
"id" : "c201d980-fd70-4ed4-bc32-9b7908a878f3",
"createdAt" : "/Date(1651047266873)/",
"updatedAt" : "/Date(1651090106873)/",
"version" : 8,
"externalSystem" : {
"id" : "c55bcabe-2db7-4879-aefa-8184c8534410",
"createdAt" : "/Date(1651049426873)/",
"updatedAt" : "/Date(1651061306873)/",
"version" : 4,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "customer-996",
"externalBrowsableUrl" : "http://www.vendor.com/customers/996",
"externalSyncedAt" : "/Date(1651050506872)/",
"externalSynced" : true,
"name" : "Example Ltd.",
"code" : "EXL",
"email" : "info@example.com",
"billsCount" : 2,
"projectsCount" : 1,
"streetAddress" : "Rua 123 Sul Avenida Lo 15",
"additionalAddressInfo" : "",
"zipCode" : "89020-000",
"city" : "Palmas",
"state" : "Tocantins",
"countryCode" : "BRA",
"phone" : "+66 987 654 321",
"vatId" : "23.456.789/0001-77",
"website" : "http://www.example.com/",
"consentTill" : "/Date(1682586506873)/",
"displayName" : "Example Ltd."
},
"billable" : true,
"autoMembership" : false,
"membersCount" : 1,
"tasksCount" : 3,
"timeRecordsCount" : 2,
"displayName" : "Content management system"
},
"name" : "Article editation",
"code" : "ART",
"note" : "form with validation",
"done" : true,
"author" : {
"id" : "2d333e9f-893d-4d6a-bd11-10280c379d65",
"createdAt" : "/Date(1651050206873)/",
"updatedAt" : "/Date(1651118906873)/",
"version" : 6,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "qa30srs_fbzfvhu@testdata.com",
"phone" : "55 234 555 678",
"position" : "Senior developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "yyyy-MM-dd",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "pt_BR",
"password" : "npfxyz11_xhs2qp01u4k",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1652911200000)/",
"workingTimeStart" : "/Date(1651039200000)/",
"workingTimeEnd" : "/Date(1651071600000)/",
"created" : "/Date(1650964106872)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"owner" : {
"id" : "0ffa5016-f43a-4af4-8fb7-cef0fa92ef8a",
"createdAt" : "/Date(1651048586873)/",
"updatedAt" : "/Date(1651082906873)/",
"version" : 0,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "ut6iiiis2j1saxp@testdata.com",
"phone" : "55 234 555 678",
"position" : "Senior developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "yyyy-MM-dd",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "pt_BR",
"password" : "n74b2jhhbh5e3g40huj9",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1652911200000)/",
"workingTimeStart" : "/Date(1651039200000)/",
"workingTimeEnd" : "/Date(1651071600000)/",
"created" : "/Date(1650964106873)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"timeBudget" : 86400000,
"priceBudget" : 1000.0,
"displayName" : "Article editation"
}