Free cells that were marked by hand

POST

/api/v1/sheets/{code}/cells/unmark

curl --request POST \
  --url https://example.com/api/v1/sheets/example/cells/unmark \
  --header 'Content-Type: application/json' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>' \
  --data '{ "cells": [ 1 ] }'

Authorizations

• APIKeyHeader

Parameters

Path Parameters

code

required

Code

Sheet code, e.g. L4736-0002.

string

<= 24 characters /^[A-Z][A-Z0-9]{1,9}-[0-9]{4,}$/

Sheet code, e.g. L4736-0002.

Request Body^required

Media typeapplication/json

CellNumbers

object

cells

required

Cells

Array<integer>

>= 1 items <= 400 items

Example ^generated

{
  "cells": [
    1
  ]
}

Responses

200

Successful Response

Media typeapplication/json

SheetRead

object

cells

required

Cells

Every cell that is not free, by cell number.

Array<object>

CellRead

object

cell

required

Cell

integer

is_id_cell

required

Is Id Cell

Whether the cell holds the sheet’s ID label (the hub fills it). Set by the hub; do not infer it from source.

boolean

job_id

required

Job Id

Any of:

string

string format: uuid

null

null

marked_by_hand

required

Marked By Hand

boolean

purpose

required

Purpose

Any of:

string

string

null

null

ref

required

Ref

Any of:

string

string

null

null

source

required

Source

string

state

required

State

string

Allowed values: reserved used unconfirmed

updated_at

required

Updated At

Any of:

string

string

null

null

code

required

Code

string

discarded_at

required

Discarded At

Any of:

string

string

null

null

feed_mark_printed

required

Feed Mark Printed

Whether the feed-direction mark has been printed on this sheet.

boolean

free

required

Free

integer

geometry

required

GeometryMm

Geometry of the version the sheet is pinned to.

object

cols

required

Cols

integer

>= 1 <= 400

corner_radius

Corner Radius

Any of:

number

number

<= 1000

null

null

label_h

required

Label H

number

<= 1000

label_w

required

Label W

number

<= 1000

margin_left

required

Margin Left

number

<= 1000

margin_top

required

Margin Top

number

<= 1000

page_h

Page H

Any of:

number

number

<= 1000

null

null

page_size

required

Page Size

string

Allowed values: A4 Letter

page_w

Page W

Any of:

number

number

<= 1000

null

null

pitch_x

required

Pitch X

number

<= 1000

pitch_y

required

Pitch Y

number

<= 1000

rows

required

Rows

integer

>= 1 <= 400

shape

required

Shape

string

Allowed values: rectangle round

id_placement

required

Id Placement

string

Allowed values: cell margin manual

id_printed

required

Id Printed

boolean

label_h

required

Label H

number

label_w

required

Label W

number

last_used_at

required

Last Used At

Any of:

string

string

null

null

note

required

Note

Any of:

string

string

null

null

reserved

required

Reserved

integer

state

required

State

string

Allowed values: active discarded

total

required

Total

integer

type_key

required

Type Key

string

type_label

required

Type Label

string

unconfirmed

required

Unconfirmed

integer

used

required

Used

integer

version

required

Version

integer

Example

{
  "cells": [
    {
      "state": "reserved"
    }
  ],
  "geometry": {
    "page_size": "A4",
    "shape": "rectangle"
  },
  "id_placement": "cell",
  "state": "active"
}

404

Sheet not found.

Media typeapplication/json

object

detail

required

object

error_code

required

string

error_detail

Any of:

object

object

key

additional properties

any

null

null

error_message

required

string

Example ^generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}

409

Sheet is discarded, or the cells are in the wrong state.

Media typeapplication/json

object

detail

required

object

error_code

required

string

error_detail

Any of:

object

object

key

additional properties

any

null

null

error_message

required

string

Example ^generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}

422

A cell number is outside the sheet.

Media typeapplication/json

object

detail

required

object

error_code

required

string

error_detail

Any of:

object

object

key

additional properties

any

null

null

error_message

required

string

Example ^generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}