Set Task Status to Completed

Transition a task to Completed

post

Transition a task to Completed. Allowed only for the owner service or extension. Valid when status is Processing.

Path parameters

idstringRequired

The task ID.

Responses

200

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

statusstring · enumOptionalPossible values:

codestringOptional

queuestringOptional

descriptionstringOptional

progressnumber · float · nullableOptional

etastring · date-time · nullableOptional

parametersany · nullableOptional

resultstring · nullableOptional

externalIdstring · nullableOptional

post

/public/v1/system/tasks/{id}/complete

POST /public/v1/system/tasks/{id}/complete HTTP/1.1
Host: api.s1.show
Accept: */*

200

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "started": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "completed": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "failed": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "rescheduled": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queued": {
      "at": "2026-03-30T19:50:04.083Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "status": "Queued",
  "code": "text",
  "queue": "text",
  "object": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "description": "text",
  "parent": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "started": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "completed": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "failed": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "rescheduled": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "queued": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "status": "Queued",
    "code": "text",
    "queue": "text",
    "object": {
      "id": "text",
      "name": "text",
      "icon": "text"
    },
    "description": "text",
    "parent": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "started": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "completed": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "failed": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "rescheduled": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "queued": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "status": "Queued",
      "code": "text",
      "queue": "text",
      "object": {
        "id": "text",
        "name": "text",
        "icon": "text"
      },
      "description": "text",
      "parent": "[Circular Reference]",
      "progress": 1,
      "eta": "2026-03-30T19:50:04.083Z",
      "parameters": null,
      "result": "text",
      "externalId": "text",
      "owner": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T19:50:04.083Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T19:50:04.083Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1
      },
      "access": [
        {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T19:50:04.083Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T19:50:04.083Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active"
        }
      ]
    },
    "progress": 1,
    "eta": "2026-03-30T19:50:04.083Z",
    "parameters": null,
    "result": "text",
    "externalId": "text",
    "owner": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "access": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T19:50:04.083Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T19:50:04.083Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      }
    ]
  },
  "progress": 1,
  "eta": "2026-03-30T19:50:04.083Z",
  "parameters": null,
  "result": "text",
  "externalId": "text",
  "owner": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T19:50:04.083Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "access": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T19:50:04.083Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active"
    }
  ]
}

PreviousSet Task Status to Queued NextSet Task Status to Rescheduled

Last updated 1 month ago

Was this helpful?

{ "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "started": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "completed": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "failed": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "rescheduled": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "queued": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1, "status": "Queued", "code": "text", "queue": "text", "object": { "id": "text", "name": "text", "icon": "text" }, "description": "text", "parent": { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "started": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "completed": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "failed": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "rescheduled": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "queued": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1, "status": "Queued", "code": "text", "queue": "text", "object": { "id": "text", "name": "text", "icon": "text" }, "description": "text", "parent": { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "started": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "completed": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "failed": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "rescheduled": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "queued": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1, "status": "Queued", "code": "text", "queue": "text", "object": { "id": "text", "name": "text", "icon": "text" }, "description": "text", "parent": "[Circular Reference]", "progress": 1, "eta": "2026-03-30T19:50:04.083Z", "parameters": null, "result": "text", "externalId": "text", "owner": { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1 }, "access": [ { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1, "type": "Client", "status": "Active" } ] }, "progress": 1, "eta": "2026-03-30T19:50:04.083Z", "parameters": null, "result": "text", "externalId": "text", "owner": { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1 }, "access": [ { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1, "type": "Client", "status": "Active" } ] }, "progress": 1, "eta": "2026-03-30T19:50:04.083Z", "parameters": null, "result": "text", "externalId": "text", "owner": { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1 }, "access": [ { "id": "text", "audit": { "created": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } }, "updated": { "at": "2026-03-30T19:50:04.083Z", "by": { "id": "text", "name": "text", "icon": "text", "revision": 1 } } }, "$meta": { "omitted": [ "text" ] }, "name": "text", "icon": "text", "revision": 1, "type": "Client", "status": "Active" } ] }

hashtagTransition a task to Completed

Transition a task to Completed