Item Logo
Yms apiTask management

POST Stop Task

POST Stop task

Introduction

Completes and closes an active yard task, marking it as finished and recording the completion time. This API is called when the assigned user has successfully completed the task operations such as loading, unloading, or moving equipment. The task status transitions to completed, finalizing all time tracking and enabling performance metrics calculation.

POST /public/task/{taskId}/stop

Request Parameters

Name

Location

Type

Required

Description

taskId

path

string

Yes

none

X-Tenant-ID

header

string

No

none

X-Yard-ID

header

string

No

none

Item-Time-Zone

header

string

No

none

Authorization

header

string

No

none

Item-Bam-Client

header

string

No

none

x-facility-id

header

string

No

none

Response Example

200 Response

Response

Status Code

Definition

Description

Data Model

200

OK

none

RGeneralTaskView