Ga naar inhoud

Taken

Asynchrone provisioning-operaties maken een Task aan. Statuses: PENDING, RUNNING, OK, FAILED, CANCELLED, PAUSED.

Alle taken weergeven

Retourneert alleen taken van de laatste 3 dagen. Om eerdere taken te zien, moet je de ID al kennen en het endpoint om een taak te bekijken gebruiken.

Zonder account-scope retourneert dit de taken die door je gebruiker zijn gestart, over alle accounts heen. Als je deze api-aanroep aan een account scopet, retourneer je ALLE taken die met dat account zijn geassocieerd, ongeacht wie ze heeft geïnitieerd.

Voor meer taakdetails of site-specifieke taken kun je het specifieke endpoint voor Site-taken gebruiken.

GET /api/tasks

Geretourneerde params
  • tasks: Array
    • id: Integer
    • name: String
    • title: String
    • status: String
    • data: String
    • start_on: DateTime
    • end_on: DateTime
    • user: Object
      • id: String
      • email: String
    • accounts: Array
      • id: String
      • name: String
    • sites: Array
      • id: String
      • name: String
    • orders: Array
      • id: String
      • status: String

Taak bekijken

GET /api/tasks/:id

Geretourneerde params
  • task: Object
    • id: Integer
    • name: String
    • title: String
    • status: String
    • data: String
    • start_on: DateTime
    • end_on: DateTime
    • user: Object
      • id: String
      • email: String
    • accounts: Array
      • id: String
      • name: String
    • sites: Array
      • id: String
      • name: String
    • orders: Array
      • id: String
      • status: String

Callbacks

In plaats van te pollen kun je een callback aan een bestelling koppelen en SuperSpace naar je URL laten POSTen wanneer de taak klaar is. Het callback-contract, de bereikbaarheidstest (GET /api/webhooks/task) en het endpoint om het resultaat te rapporteren (POST /api/webhooks/task/{task-id}) zijn allemaal gedocumenteerd op de Callbacks-pagina.