Stage Import¶

Endpoint: POST /api/application-imports/stage

Description: Stages a new scheduled import for the specified application.

Request Body¶

Field	Type	Required	Description
`applicationId`	string (GUID)	Yes	The unique identifier of the application to import. Must reference an existing, non-archived application with an import schedule configured.

Sample Request¶

{
  "applicationId": "b8c1d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e"
}

Response Attributes¶

Field	Type	Description
`id`	string (GUID)	Unique identifier of the created import.
`kind`	string	Resource type. Always `Application Import`.
`number`	integer	Sequential import number.
`type`	string	Import type.
`status`	string	Import status.
`createdBy`	string	Username that initiated the import.
`buildStart`	string (ISO 8601)	Date and time the import started.
`buildEnd`	string (ISO 8601)	Date and time the import completed. `null` if still running.
`log`	string	Import build log output.
`files`	array[object]	Files associated with this import.
`files[].id`	string (GUID)	Unique identifier of the import file.
`files[].fileGroupId`	string (GUID)	File group identifier.
`files[].fileGroup`	string	Display name of the file group.
`files[].name`	string	Original file name.
`metrics`	object	Import metrics. `null` until the import finishes.

Sample Response (201)¶

{
  "id": "a9b8c7d6-e5f4-3210-fedc-ba9876543210",
  "kind": "Application Import",
  "number": 48,
  "type": "API",
  "status": "Pending",
  "createdBy": "API Token - Automation Service",
  "buildStart": null,
  "buildEnd": null,
  "log": null,
  "files": [],
  "metrics": null
}

Error Response (400)¶

{
  "error": "validation_error",
  "message": "One or more validation errors occurred",
  "correlationId": "a1b2c3d4e5f6789012345678abcdef01",
  "errors": [
    {
      "field": "applicationId",
      "message": "Application is archived"
    }
  ]
}