v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Export and import

Get program import record

Get a detailed program import record, including the import steps and their statuses.

get/programs/v1/programs/import/{id}

Path parameters

idinteger required

Program import ID

Response

idinteger

Program import ID

program_idnumber

Pismo program ID.

status'PENDING' | 'PROCESS' | 'SUCCESS' | 'ERROR'

Program import status

file_urlstring

File URL for downloading the import. Contains part of the path and JSON file name.

detailsstring

Program importer details

started_atstring

Program import start datetime. Format = yyyy-mm-ddThh:mm:ss.

finished_atstring

When program import finished. Format = yyyy-mm-ddThh:mm:ss.

Example response

{
  "id": 1234,
  "program_id": 1010,
  "status": "SUCCESS",
  "file_url": "https://programs-api.s3.amazonaws.com/TENANT/import/file.json",
  "details": "Import process details",
  "started_at": "2021-09-22T15:00:00Z",
  "finished_at": "2021-09-22T15:45:00Z",
  "program_import_steps": [
    {
      "id": 12,
      "name": "PROGRAM",
      "order": 1,
      "status": "SUCCESS",
      "details": "Import step details",
      "started_at": "2021-09-23T10:05:00Z",
      "finished_at": "2021-09-23T10:15:45Z",
      "deleted_at": "2021-09-23T10:10:25Z"
    }
  ]
}