Lock
URL
https://api.primatime.com/v1/time/locks
Properties
| Name |
Type |
Access |
Required |
Description |
| client |
Client |
read write |
no |
The client whose time records are locked. |
| createdAt |
Date |
read only |
no |
Date of creation. |
| displayName |
String |
read only |
no |
Describes an object in human readable form. |
| id |
String |
read write |
no |
Unique object identifier. |
| lockedTo |
Date |
read write |
no |
Time records created beforer this date are locked. |
| note |
String |
read write |
no |
Additional note. |
| project |
Project |
read write |
no |
The project whose time records are locked. |
| 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. |
| user |
User |
read write |
no |
The user whose time records are locked. |
| version |
Long |
read write |
no |
Object version number. |
{
"type" : "Lock",
"path" : "/v1/time/locks",
"fields" : [
{
"type" : "Client",
"path" : "/v1/time/clients",
"name" : "client",
"description" : "The client whose time records are locked.",
"access" : "READ_WRITE"
},
{
"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" : "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" : "Date",
"name" : "lockedTo",
"description" : "Time records created beforer this date are locked.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "note",
"description" : "Additional note.",
"access" : "READ_WRITE"
},
{
"type" : "Project",
"path" : "/v1/time/projects",
"name" : "project",
"description" : "The project whose time records are locked.",
"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" : "User",
"path" : "/v1/users",
"name" : "user",
"description" : "The user whose time records are locked.",
"access" : "READ_WRITE"
},
{
"type" : "Long",
"name" : "version",
"description" : "Object version number.",
"access" : "READ_WRITE"
}
],
"cascades" : [
{
"cascadeType" : "REMOVE",
"objectTypes" : [
"TrashItem"
]
}
]
}
Dummy data
{
"id" : "d1b6c896-0a48-4ef4-8378-afbbdcd99893",
"createdAt" : "/Date(1651047387330)/",
"updatedAt" : "/Date(1651090107330)/",
"version" : 1,
"user" : {
"id" : "8013ccf0-869a-4f09-9c24-493782ba0281",
"createdAt" : "/Date(1651048767330)/",
"updatedAt" : "/Date(1651108107330)/",
"version" : 7,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "khe7071vabymwj_@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" : "28j5abfkowa5amrb4k5k",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1652911200000)/",
"workingTimeStart" : "/Date(1651039200000)/",
"workingTimeEnd" : "/Date(1651071600000)/",
"created" : "/Date(1650964107330)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"client" : {
"id" : "2d499c80-bbe2-4034-8d6c-918d3f2ca193",
"createdAt" : "/Date(1651048287330)/",
"updatedAt" : "/Date(1651057707330)/",
"version" : 8,
"externalSystem" : {
"id" : "fd455c7a-9436-47c6-9e6f-40140679d284",
"createdAt" : "/Date(1651048647330)/",
"updatedAt" : "/Date(1651129707330)/",
"version" : 8,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "customer-996",
"externalBrowsableUrl" : "http://www.vendor.com/customers/996",
"externalSyncedAt" : "/Date(1651050507330)/",
"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(1682586507330)/",
"displayName" : "Example Ltd."
},
"project" : {
"id" : "e1208609-286c-43d6-b859-c33148987834",
"createdAt" : "/Date(1651048287330)/",
"updatedAt" : "/Date(1651072107330)/",
"version" : 1,
"externalSystem" : {
"id" : "e3e7fd96-b5f2-4659-aeb0-896dffacd750",
"createdAt" : "/Date(1651050147330)/",
"updatedAt" : "/Date(1651129707330)/",
"version" : 0,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "project-221",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221",
"externalSyncedAt" : "/Date(1651050507330)/",
"externalSynced" : true,
"name" : "Content management system",
"code" : "CMS",
"note" : "core feature",
"begins" : "/Date(1648372107330)/",
"ends" : "/Date(1650445707330)/",
"timeBudget" : 604800000,
"priceBudget" : 100000.0,
"personal" : false,
"owner" : {
"id" : "8013ccf0-869a-4f09-9c24-493782ba0281",
"createdAt" : "/Date(1651048767330)/",
"updatedAt" : "/Date(1651108107330)/",
"version" : 7,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "khe7071vabymwj_@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" : "28j5abfkowa5amrb4k5k",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1652911200000)/",
"workingTimeStart" : "/Date(1651039200000)/",
"workingTimeEnd" : "/Date(1651071600000)/",
"created" : "/Date(1650964107330)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"client" : {
"id" : "2d499c80-bbe2-4034-8d6c-918d3f2ca193",
"createdAt" : "/Date(1651048287330)/",
"updatedAt" : "/Date(1651057707330)/",
"version" : 8,
"externalSystem" : {
"id" : "fd455c7a-9436-47c6-9e6f-40140679d284",
"createdAt" : "/Date(1651048647330)/",
"updatedAt" : "/Date(1651129707330)/",
"version" : 8,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "customer-996",
"externalBrowsableUrl" : "http://www.vendor.com/customers/996",
"externalSyncedAt" : "/Date(1651050507330)/",
"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(1682586507330)/",
"displayName" : "Example Ltd."
},
"billable" : true,
"autoMembership" : false,
"membersCount" : 1,
"tasksCount" : 3,
"timeRecordsCount" : 2,
"displayName" : "Content management system"
},
"lockedTo" : "/Date(1651050507330)/",
"note" : "Johnny can no longer track his time on the CMS project.",
"displayName" : "Wed Apr 27 11:08:27 CEST 2022"
}