CHcharthop
scenario

Combine multiple scenarios into another scenario

post/v1/org/{orgId}/scenario/{scenarioId}/combine

Request

Path parameters

orgIdstring required

Org identifier (either id or slug)

scenarioIdstring required

Scenario id to combine the other scenarios into

Request body

scenarioIdsstring[] required

scenarios to combine

copyOnlyboolean
useScenarioDateForChangesboolean

Example request

{
  "scenarioIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent org id

labelstring required

human-readable label that identifies this process

typestring required

process type

status'PENDING' | 'RUNNING' | 'DONE' | 'ERROR' required

current status of process

filePathstring

data file path

logPathstring

data log path

runUserIdstring required

user id who is running the process; the app user itself for an app-owned (appId) process

parentProcessIdstring

process id of parent process

createIdstring required

created by user id (user who requested the process run)

createBehalfIdstring

created on behalf of user id

createAtstring required

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

startAtstring

started at timestamp

endAtstring

ended at timestamp

messagestring

status or error message

progressnumber double

percent progress so far

internalErrorstring

internal-only error message

optionsobject required

options passed to the process

resultsobject

results summary for the process

stateobject

process-specific state data

summarystring

human-readable, searchable summary of what this process did

appIdstring

app id of the process

uuidstring

unique ID of the process at queue time

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "runUserId": "588f7ee98f138b19220041a7",
  "parentProcessId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "startAt": "2017-01-24T13:57:52Z",
  "endAt": "2017-01-24T13:57:52Z",
  "logDataList": [
    {
      "at": "2017-01-24T13:57:52Z"
    }
  ],
  "appId": "588f7ee98f138b19220041a7",
  "uuid": "84db3c6e-0877-4436-8af1-768c06b29586"
}

Changes

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