change

Amend a change within a scenario, and potentially return the updated data

patch/v1/org/{orgId}/scenario/{scenarioId}/change/{changeId}

Request

Base URL
https://localhost
Auth
none declared
TypeScript
https://skmtc.dev/charthop/apis/charthop-api/docs/v1/org/:orgId/scenario/:scenarioId/change/:changeId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

Org identifier (either id or slug)

scenarioIdstring required

Scenario id

changeIdstring required

Change id

Query parameters

fieldsstring

Fields to retrieve

includeUpdatedFieldsboolean

Include all updated fields in the response, including change.after.fieldName for each updated field

formatstring

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

Request body

object required

Response

successful operation

processIdinteger required

Example response

{
  "data": [
    {
      "change": {
        "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"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 34 revisions of this API.