Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Installer Jobs

Archive an installer job

Archive an installer job. Archiving is idempotent: re-archiving an already archived job leaves it unchanged.<br>Required scope: installer-jobs:write

post/api/v1/installer-jobs/{installerJobId}/archive

Path parameters

installerJobIdinteger required

Response

The archived installer job

idinteger

Id of this installer job

siteIdinteger

Id of the site related to this installer job

teamIdinteger

Id of the team of this installer job

descriptionstring nullable

Description of this installer job, will be visible to the installer

publicLinkstring required

Public link of this installer job, shareable with the installer

chargePointCountinteger

Number of charge points included in this installer job

chargePointActiveCountinteger

Number of active (finished) charge points in this installer job

emailstring nullable

Email of the installer assigned to this job.

completedAtstring date-time nullable

Date this installer job was completed

createdAtstring date-time required

Date this installer job was created

updatedAtstring date-time nullable

Date this installer job was updated

deletedAtstring date-time nullable

Date this installer job was deleted

Example response

{
  "id": 42,
  "siteId": 22,
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "teamId": 4124,
  "description": "5",
  "publicLink": "https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da",
  "chargePointCount": 5,
  "chargePointActiveCount": 3,
  "email": "installer@acme.org",
  "tasks": [
    {
      "id": 42,
      "installerJobId": 5,
      "chargePointId": 21,
      "serialNumber": "1",
      "connector": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "completedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}