Changelog
Changes to the endpoints on this site, newest first.
- New: List Principals (
GET /principals) resolves a principal id to its type and name. A principal is a user (USER), a user group (GROUP) or an API key (API_KEY). A group also lists the principal ids of its members. Every item carriesdeleted_at, the time of its removal,nullfor a current member. Removed principals are also listed, see List Principals. A group carrieslegacy_user_id, the id that v1ASSIGNEEandUSERvalues hold for it. Sitemark plans to add more types. A new type is not a breaking change: your integration must skip atypeit does not know, or show it as unknown, and must not fail on it. - Changed: List Property Changes
(
GET /propertyChanges) returnsprincipal_id: the principal that made the change. It isnullfor older changes, system changes, changes caused by another change, and values that a formula calculates. A principal id can have no row in List Principals, for example the author is of another company: show it as unknown. A principal id is not a user id: a v1ASSIGNEEorUSERvalue is a user or group id. See ResolveASSIGNEEandUSERvalues. - Deprecated:
user_idof List Property Changes. It isnullfor a change made with an API key. Readprincipal_idwhen it is set, elseuser_id. Resolve both with List Principals. The removal date ofuser_idwill be announced here first. - Deprecated: List Users (
GET /users). Use List Principals instead. The removal date ofGET /userswill be announced here first. - New:
ASSIGNEEandUSERvalues have a v2 shape:{ "version": "2", "principal_id": <id> }. Create Ticket and Update Ticket Fields accept it for a user, or a group that has alegacy_user_id. Sitemark can store a value in a shape other than the shape you sent, depending on the progress of its migration. Existing values stay v1. So your integration must read both shapes now: ResolveASSIGNEEandUSERvalues. v1 is not deprecated for reads. - Deprecated: a v1
ASSIGNEEorUSERvalue (a user or group id) in Create Ticket and Update Ticket Fields. Send v2. v1 writes can be removed in the future. - Fixed: List Schedule Activities
(
GET /scheduleActivities) returned an emptydataset_name, and an emptyunitfor an activity that counts components, when the activity is linked to a custom component type. Both now carry the component type’s name. A linked activity whose component type has no name returnsdataset_namenull.
- New: List Users (
GET /users) takesinclude_deletedto also list the users and user groups removed from a company, so you can resolve their ids to a name. Every item now carriesdeleted_at, the time of the removal,nullfor a current member. - Changed: On most endpoints, a body or query that doesn’t match the endpoint’s schema now
returns
400with the message"The request is invalid."and anissueslist with the codeINVALID_REQUEST, instead of"Bad Request". See Errors.
- New: Create Operation (
POST /operations) creates aDRAFTorORDEREDoperation on a site.