Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Create a new series idempotently with the given UUID (any version).

put/sequence/v1/series/{id}

Path parameters

idstring required

The UUID (any version) of the series to create.

Example:a8904315-3d16-4a95-91c1-30d6cdde553e

The UUID (any version) of the series to create.

Request body

codestring

A code that can be used to identify the series.

descriptionstring

A description of the series.

namestring

The name of the series.

paddinginteger

The number of 0s to pad the generated codes with.

prefixstring

A prefix that will be prepended to all entries.

sigstring

JSON Web Signature of the key properties used to create the series.

startinteger

The starting index for the series.

suffixstring

A suffix that will be appended to all entries.

Example request

{
  "code": "SALES-2020",
  "description": "This series is used for sales.",
  "name": "My Series",
  "padding": 5,
  "prefix": "INV-",
  "start": 1,
  "suffix": "-F1"
}

Response

OK

codestring

A code that can be used to identify the series.

created_atstring

The date and time the series was created.

descriptionstring

A description of the series.

idstring

The UUID (any version) of the series.

last_entry_idstring

The ID of the last entry in the series.

last_indexinteger

The last index used in the series.

namestring

The name of the series.

paddinginteger

The number of 0s to pad the generated codes with.

prefixstring

A prefix that will be prepended to all entries.

suffixstring

A suffix that will be appended to all entries.

updated_atstring

The date and time the series was last updated.

Example response

{
  "code": "SALES-2020",
  "created_at": "2020-10-01T00:00:00Z",
  "description": "This series is used for sales.",
  "id": "a8904315-3d16-4a95-91c1-30d6cdde553e",
  "last_entry_id": "a8904315-3d16-4a95-91c1-30d6cdde553e",
  "last_index": 100,
  "name": "My Series",
  "padding": 5,
  "prefix": "INV-",
  "suffix": "-F1",
  "updated_at": "2020-10-01T00:00:00Z"
}