Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
change

Create a depart-rehire pair of changes, for filling in historical data

post/v1/org/{orgId}/change/depart-rehire

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

startDatestring date

Rehire start date

Request body

jobIdstring

job id

orgIdstring

parent organization id

scenarioIdstring

scenario that this change belongs to

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

type'HIRE' | 'DEPART' | 'MOVE' | 'UPCOMING' | 'CREATE' | 'UPDATE' | 'DATA' | 'DELETE' | 'RELATE' | 'BACKFILL'

type of change

datestring date

date of change

announceDatestring date

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

departType'VOLUNTARY' | 'INVOLUNTARY'

for DEPART changes, the type of departure

departRegret'REGRET' | 'NONREGRET'

for DEPART changes, whether the departure is regrettable

reasonstring

the reason of the change

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

if it's a promotion or a demotion

notestring

note on the change

mergeIdstring

merged by user id, if this change was merged

mergeScenarioIdstring

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

overrideDefaultsobject

for job code linked field overrides, records the default job code value

autoAppliedDefaultsobject

for job code linked fields, records which fields were auto-populated from defaults

Example request

{
  "jobId": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "scenarioId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "otherJobId": "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"
  },
  "update": {
    "addRelationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "removeRelationships": [
      {
        "jobId": "5887a7718f138b6a2a0041a7"
      }
    ],
    "addGroupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "removeGroupIds": [
      "588f7ee98f138b19220041a7"
    ],
    "grant": {
      "stock": "GOOG"
    },
    "backfillPersonId": "588f7ee98f138b19220041a7",
    "jobCodeId": "588f7ee98f138b19220041a7"
  },
  "mergeId": "588f7ee98f138b19220041a7",
  "mergeScenarioId": "588f7ee98f138b19220041a7"
}

Response

accepted