Skip to content

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 carries deleted_at, the time of its removal, null for a current member. Removed principals are also listed, see List Principals. A group carries legacy_user_id, the id that v1 ASSIGNEE and USER values hold for it. Sitemark plans to add more types. A new type is not a breaking change: your integration must skip a type it does not know, or show it as unknown, and must not fail on it.
  • Changed: List Property Changes (GET /propertyChanges) returns principal_id: the principal that made the change. It is null for 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 v1 ASSIGNEE or USER value is a user or group id. See Resolve ASSIGNEE and USER values.
  • Deprecated: user_id of List Property Changes. It is null for a change made with an API key. Read principal_id when it is set, else user_id. Resolve both with List Principals. The removal date of user_id will be announced here first.
  • Deprecated: List Users (GET /users). Use List Principals instead. The removal date of GET /users will be announced here first.
  • New: ASSIGNEE and USER values 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 a legacy_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: Resolve ASSIGNEE and USER values. v1 is not deprecated for reads.
  • Deprecated: a v1 ASSIGNEE or USER value (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 empty dataset_name, and an empty unit for 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 returns dataset_name null.
  • New: List Users (GET /users) takes include_deleted to also list the users and user groups removed from a company, so you can resolve their ids to a name. Every item now carries deleted_at, the time of the removal, null for a current member.
  • Changed: On most endpoints, a body or query that doesn’t match the endpoint’s schema now returns 400 with the message "The request is invalid." and an issues list with the code INVALID_REQUEST, instead of "Bad Request". See Errors.
  • New: Create Operation (POST /operations) creates a DRAFT or ORDERED operation on a site.