v3

latestSwagger 2.02026-08-067506752.0 MB

change

Return a particular change by id

get/v1/org/{orgId}/change/{changeId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

changeIdstring required

Change id

Query parameters

formatstring

Data format to use; default is json, can also use json-extended or json-readable

Response

successful operation

idstring required

unique id

jobIdstring required

job id

orgIdstring required

parent organization id

scenarioIdstring

scenario that this change belongs to

mergeScenarioIdstring

scenario that this change was merged in from, if the change originally came from a scenario

parentChangeIdstring

change that this change emanates from

priorStateChangeIdstring

connects this change to a previous version if itself that you might want to roll back to because of bad edits

type of change

datestring date required

date of change

sortinteger

sort order of change

announceDatestring date

for HIRE and DEPART changes, the announce date, if the announce date is different from the date of change

status'ACTIVE' | 'STRUCK' | 'CONFLICT' | 'INACTIVE' | 'PROPOSED' required

whether the change is active or not

personIdstring

the id of the person involved, or empty if no person attached to job

otherJobIdstring

for MOVE changes, the id of the job moving from; for RELATE changes, the id of the other job

otherPersonIdstring

for MOVE changes, the id of the other person involved in the move

departType'VOLUNTARY' | 'INVOLUNTARY'

for DEPART changes, the type of departure

departRegret'REGRET' | 'NONREGRET'

for DEPART changes, whether the departure was regrettable

promotionType'PROMOTION' | 'DEMOTION' | 'NONE'

if it's a promotion or a demotion

reasonstring

the reason for the change

relateType'MANAGER' | 'DIRECT' | 'INDIRECT_MANAGER' | 'INDIRECT' | 'NONE'

for RELATE changes, the type of the relationship

refsobject[]

list of ids referenced in text field body, for indexing purposes only

formIdstring

if this change was data submitted by a form, the id of that form

formResponseIdstring

if this change is associated with a form response, the id of that form response

assessmentIdstring

if this change is associated with a assessment, the id of that assessment

conflictstring

for changes that have been struck due to a merge conflict, the description of the conflict

notestring

note on the change

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

mergeIdstring

merged by user id, if this change was merged

createAtstring

created timestamp

updateAtstring

updated timestamp

updateIdstring

updated by user id

updateBehalfIdstring

last updated on behalf of user id

statusAtstring

timestamp of status change

approvalAtstring

timestamp of approval

approvalIdstring

approved by user id

approvalNotestring

approval/rejection note

approval'MANAGER' | 'GRAND_MANAGER'

if approval is required, who is allowed to approve

view sensitivity for the author author of this form - the level of view access required to view the createId and updateId fields

canEditboolean

flag indicating whether authorized user can modify this change (will vary depending on user)

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "jobId": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "scenarioId": "588f7ee98f138b19220041a7",
  "mergeScenarioId": "588f7ee98f138b19220041a7",
  "parentChangeId": "588f7ee98f138b19220041a7",
  "priorStateChangeId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "otherJobId": "588f7ee98f138b19220041a7",
  "otherPersonId": "588f7ee98f138b19220041a7",
  "job": {
    "jobId": "588f7ee98f138b19220041a7",
    "orgId": "588f7ee98f138b19220041a7",
    "snapshotId": "588f7ee98f138b19220041a7",
    "title": "Senior Engineer",
    "relationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "groupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "personId": "588f7ee98f138b19220041a7",
    "backfillPersonId": "588f7ee98f138b19220041a7",
    "jobCodeId": "588f7ee98f138b19220041a7",
    "backfillByJobId": "588f7ee98f138b19220041a7",
    "upcoming": [
      {
        "id": "588f7ee98f138b19220041a7",
        "personId": "588f7ee98f138b19220041a7",
        "otherPersonId": "588f7ee98f138b19220041a7"
      }
    ],
    "scenarioId": "588f7ee98f138b19220041a7",
    "scenarioChangedId": "588f7ee98f138b19220041a7"
  },
  "otherJob": {
    "jobId": "588f7ee98f138b19220041a7",
    "orgId": "588f7ee98f138b19220041a7",
    "snapshotId": "588f7ee98f138b19220041a7",
    "title": "Senior Engineer",
    "relationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "groupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "personId": "588f7ee98f138b19220041a7",
    "backfillPersonId": "588f7ee98f138b19220041a7",
    "jobCodeId": "588f7ee98f138b19220041a7",
    "backfillByJobId": "588f7ee98f138b19220041a7",
    "upcoming": [
      {
        "id": "588f7ee98f138b19220041a7",
        "personId": "588f7ee98f138b19220041a7",
        "otherPersonId": "588f7ee98f138b19220041a7"
      }
    ],
    "scenarioId": "588f7ee98f138b19220041a7",
    "scenarioChangedId": "588f7ee98f138b19220041a7"
  },
  "formId": "588f7ee98f138b19220041a7",
  "formResponseId": "588f7ee98f138b19220041a7",
  "assessmentId": "588f7ee98f138b19220041a7",
  "update": {
    "addRelationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "removeRelationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "addGroupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "removeGroupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "grant": {
      "stock": "GOOG"
    },
    "backfillPersonId": "588f7ee98f138b19220041a7",
    "jobCodeId": "588f7ee98f138b19220041a7"
  },
  "upcoming": {
    "id": "588f7ee98f138b19220041a7",
    "personId": "588f7ee98f138b19220041a7",
    "otherPersonId": "588f7ee98f138b19220041a7"
  },
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "mergeId": "588f7ee98f138b19220041a7",
  "createAt": "2017-01-24T13:57:52Z",
  "updateAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "approvalId": "588f7ee98f138b19220041a7",
  "approvalNote": "Not acceptable"
}