API docs by Redocly

Folio Serials Management (2.0.0)

API for the Folio library services platform mod-serials-management app

Get a set of locales

Authorizations:
accessTokenokapiToken
query Parameters
keyLocales
boolean
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a set of reference data categories and values

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer

Responses

Response samples

Content type
application/json
Example
[ ]

Create new reference data

Authorizations:
accessTokenokapiToken
Request Body schema: application/json
required
id
string <uuid>
internal
boolean
desc
string
Array of objects (RefData)
Array
id
string <uuid>
label
string
value
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "desc": "string",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "desc": "string",
  • "values": [
    ]
}

Get a specified reference data category

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the reference data category to be fetched

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "desc": "string",
  • "values": [
    ]
}

Update reference data category

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string

The uuid of the reference data category to be put

Request Body schema: application/json
required
id
string <uuid>
internal
boolean
desc
string
Array of objects (RefData)
Array
id
string <uuid>
label
string
value
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "desc": "string",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "desc": "string",
  • "values": [
    ]
}

Delete a specified reference data category

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the reference data category to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0,
  • "path": "string"
}

Get a specified reference data property

Authorizations:
accessTokenokapiToken
path Parameters
domain
required
string

The DomainClass of the reference data category to which the property belongs

property
required
string

The FieldName of the reference data property to be fetched

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "label": "string",
  • "value": "string"
}

Get a set of serial records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer

Responses

Response samples

Content type
application/json
Example
[ ]

Create serial record

Authorizations:
accessTokenokapiToken
Request Body schema: application/json
required

requestBody description

id
string <uuid>
description
string
string or RefData (object)
One of
string
object (SerialOrderLine)
object
title
string
titleId
string <uuid>
Array of objects (serialRuleset)
Array
id
string <uuid>
required
string or RefData (object)
description
string
object (Recurrence)
object (Omission)
object (Combination)
object (TemplateConfiguration)
required
Serial (object) or ModelRuleset (object)
rulesetNumber
string
Array of objects (SerialNote)
Array
id
string <uuid>
note
string
owner
object (Serial) Recursive
dateCreated
string <datetime>
lastUpdated
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "serialStatus": "string",
  • "orderLine": {
    },
  • "serialRulesets": [
    ],
  • "notes": [
    ],
  • "dateCreated": "string",
  • "lastUpdated": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "serialStatus": "string",
  • "orderLine": {
    },
  • "serialRulesets": [
    ],
  • "notes": [
    ],
  • "dateCreated": "string",
  • "lastUpdated": "string"
}

Get a specified serial record

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the serial record to be fetched

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "serialStatus": "string",
  • "orderLine": {
    },
  • "serialRulesets": [
    ],
  • "notes": [
    ],
  • "dateCreated": "string",
  • "lastUpdated": "string"
}

Update serial record

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string

The uuid of the serial record to be put

Request Body schema: application/json
required
id
string <uuid>
description
string
string or RefData (object)
One of
string
object (SerialOrderLine)
object
title
string
titleId
string <uuid>
Array of objects (serialRuleset)
Array
id
string <uuid>
required
string or RefData (object)
description
string
object (Recurrence)
object (Omission)
object (Combination)
object (TemplateConfiguration)
required
Serial (object) or ModelRuleset (object)
rulesetNumber
string
Array of objects (SerialNote)
Array
id
string <uuid>
note
string
owner
object (Serial) Recursive
dateCreated
string <datetime>
lastUpdated
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "serialStatus": "string",
  • "orderLine": {
    },
  • "serialRulesets": [
    ],
  • "notes": [
    ],
  • "dateCreated": "string",
  • "lastUpdated": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "serialStatus": "string",
  • "orderLine": {
    },
  • "serialRulesets": [
    ],
  • "notes": [
    ],
  • "dateCreated": "string",
  • "lastUpdated": "string"
}

Delete a specified serial record

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the serial record to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0,
  • "path": "string"
}

Get a set of model ruleset records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer

Responses

Response samples

Content type
application/json
Example
[ ]

Create model ruleset record

Authorizations:
accessTokenokapiToken
Request Body schema: application/json
required

Ruleset JSON

id
string <uuid>
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
required
string
description
string
exampleLabel
string
required
string or RefData (object)
One of
string
object (SerialRuleset)
id
string <uuid>
required
string or RefData (object)
description
string
object (Recurrence)
object (Omission)
object (Combination)
object (TemplateConfiguration)
required
Serial (object) or ModelRuleset (object)
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "exampleLabel": "string",
  • "modelRulesetStatus": "string",
  • "serialRuleset": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "exampleLabel": "string",
  • "modelRulesetStatus": "string",
  • "serialRuleset": {
    }
}

Get a specified model ruleset record

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the model ruleset record to be fetched

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "exampleLabel": "string",
  • "modelRulesetStatus": "string",
  • "serialRuleset": {
    }
}

Delete a specified model ruleset record

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the model ruleset record to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0,
  • "path": "string"
}

Get a set of ruleset records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer

Responses

Response samples

Content type
application/json
Example
[ ]

Create ruleset record

Authorizations:
accessTokenokapiToken
Request Body schema: application/json
required

Ruleset JSON

id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
required
object (SerialRuleset)
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
serialRulesets
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Get a specified ruleset

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset record to be fetched

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Delete a specified ruleset

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0,
  • "path": "string"
}

Activate a ruleset

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset to be activated

Request Body schema: application/json
id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
required
object (SerialRuleset)
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
serialRulesets
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Deprecate a ruleset

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset to be deprecated

Request Body schema: application/json
id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
required
object (SerialRuleset)
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
serialRulesets
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Make a ruleset a draft

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset to be made a draft

Request Body schema: application/json
id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
required
object (SerialRuleset)
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
serialRulesets
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Replace and delete an unused publication pattern

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset record to be replaced and deleted

Request Body schema: application/json
required

Ruleset JSON

id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
required
object (SerialRuleset)
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
serialRulesets
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Replace and deprecate an used publicaiton patter

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the ruleset record to be replaced and deprecated

Request Body schema: application/json
required

Ruleset JSON

id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
required
object (SerialRuleset)
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
serialRulesets
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string"
}

Get a set of predicted piece sets

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer

Responses

Response samples

Content type
application/json
Example
[ ]

Get a specified predicted piece set

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string <uuid>

The uuid of the predicted piece set to be fetched

Responses

Response samples

Content type
application/json
{
  • "continuationPieceRecurrenceMetadata": {
    },
  • "dateCreated": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialPieceRecurrenceMetadata": {
    },
  • "lastUpdated": "string",
  • "pieces": [
    ],
  • "ruleset": {
    },
  • "startDate": "2019-08-24",
  • "numberOfCycles": 0,
  • "note": "string"
}

Update predicted piece set

Authorizations:
accessTokenokapiToken
path Parameters
uuid
required
string

The uuid of the predicted piece set to be put

Request Body schema: application/json
required
object (TemplateMetadata)
id
string <uuid>
Array of objects (UserConfiguredTemplateMetadata)
dateCreated
string <datetime>
id
string <uuid>
object (TemplateMetadata)
id
string <uuid>
Array of objects (UserConfiguredTemplateMetadata)
lastUpdated
string <datetime>
required
Array of InternalCombinationPiece (object) or InternalOmissionPiece (object) or InternalRecurrencePiece (object)
Array
Any of
id
string <uuid>
class
string
templateString
string
label
string
receivingId
string <uuid>
Array of objects (ReceivingPiece)
Array of objects (InternalRecurrencePiece)
Array of objects (CombinationOrigin)
object (SerialRuleset)
id
string <uuid>
required
string or RefData (object)
description
string
object (Recurrence)
object (Omission)
object (Combination)
object (TemplateConfiguration)
required
Serial (object) or ModelRuleset (object)
rulesetNumber
string
startDate
required
string <date>
numberOfCycles
integer
note
string

Responses

Request samples

Content type
application/json
{
  • "continuationPieceRecurrenceMetadata": {
    },
  • "dateCreated": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialPieceRecurrenceMetadata": {
    },
  • "lastUpdated": "string",
  • "pieces": [
    ],
  • "ruleset": {
    },
  • "startDate": "2019-08-24",
  • "numberOfCycles": 0,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "continuationPieceRecurrenceMetadata": {
    },
  • "dateCreated": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialPieceRecurrenceMetadata": {
    },
  • "lastUpdated": "string",
  • "pieces": [
    ],
  • "ruleset": {
    },
  • "startDate": "2019-08-24",
  • "numberOfCycles": 0,
  • "note": "string"
}

Preview predicted pieces

Authorizations:
accessTokenokapiToken
Request Body schema: application/json
id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
owner
required
object (SerialRuleset) Recursive
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string
note
string
numberOfCycles
integer
Array of objects (UserConfiguredTemplateMetadata)
Array
id
string <uuid>
index
required
integer
required
EnumerationUCTMT (object) or ChronologyUCTMT (object)
string or RefData (object)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string",
  • "note": "string",
  • "numberOfCycles": 0,
  • "startingValues": [
    ]
}

Response samples

Content type
application/json
{
  • "continuationPieceRecurrenceMetadata": {
    },
  • "dateCreated": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialPieceRecurrenceMetadata": {
    },
  • "lastUpdated": "string",
  • "pieces": [
    ],
  • "ruleset": {
    },
  • "startDate": "2019-08-24",
  • "numberOfCycles": 0,
  • "note": "string"
}

Create predicted pieces

Authorizations:
accessTokenokapiToken
Request Body schema: application/json
id
string <uuid>
required
string or RefData (object)
One of
string
description
string
object (Recurrence)
required
object (TimeUnit)
period
integer
issues
integer
Array of objects (RecurrenceRule)
object (Omission)
object (Combination)
object (TemplateConfiguration)
object (Serial)
object (Omission)
Array of objects (OmissionRule)
object (Combination)
Array of objects (CombinationRule)
object (TemplateConfiguration)
id
string <uuid>
owner
required
object (SerialRuleset) Recursive
templateString
required
string
Array of objects (ChronologyTemplateMetadataRule)
Array of objects (EnumerationTemplateMetadataRule)
required
Serial (object) or ModelRuleset (object)
One of
id
string <uuid>
description
string
string or RefData (object)
object (SerialOrderLine)
Array of objects (serialRuleset)
Array of objects (SerialNote)
dateCreated
string <datetime>
lastUpdated
string <datetime>
rulesetNumber
string
note
string
numberOfCycles
integer
Array of objects (UserConfiguredTemplateMetadata)
Array
id
string <uuid>
index
required
integer
required
EnumerationUCTMT (object) or ChronologyUCTMT (object)
string or RefData (object)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rulesetStatus": "string",
  • "description": "string",
  • "recurrence": {
    },
  • "omission": {
    },
  • "combination": {
    },
  • "templateConfig": {
    },
  • "owner": {
    },
  • "rulesetNumber": "string",
  • "note": "string",
  • "numberOfCycles": 0,
  • "startingValues": [
    ]
}

Response samples

Content type
application/json
{
  • "continuationPieceRecurrenceMetadata": {
    },
  • "dateCreated": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "initialPieceRecurrenceMetadata": {
    },
  • "lastUpdated": "string",
  • "pieces": [
    ],
  • "ruleset": {
    },
  • "startDate": "2019-08-24",
  • "numberOfCycles": 0,
  • "note": "string"
}