Platform | Sequence

Service to manage entities of type 'Sequence'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/sequences

URL	api/{tenantKey}/{orgKey}/corePatterns/sequences
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Sequences
PUT:
- PUT Set IsActive Sequence
- PUT Set IsDefault Sequence
DELETE:
- DELETE Sequence by identifier
- DELETE Sequence by key

All Resources

This service uses the following resources:

ApiSequenceResource
ApiSequenceSequenceLinesResource
SequenceResource
StandardSequenceResource
StandardSequenceSequenceLinesResource

All Enumerations

This service uses the following enumerations:

SequenceSegmentType
SequenceSeparatorType

GET Operations

GET Sequences (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See SequenceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/odata

GET /corePatterns/sequences/odata

GET Sequence by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See SequenceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/{id}

GET /corePatterns/sequences/{id}

GET Sequence by key

Returns the entity record that matches the specified key.

The following elements are required:

sequenceKey

(string) The sequence's key.

Response:

When successful, the response body contains the entity record. See SequenceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/{sequenceKey}

GET /corePatterns/sequences/{sequenceKey}

GET Get Default Sequence For Entity Attribute

Custom operation 'GetDefaultSequenceForEntityAttribute'.

The following elements are required:

entityName	(string) EntityName.
attributeName	(string) AttributeName.
groupingKey	(string) GroupingKey.

Response:

When successful, the response body contains a list of resources of type 'StandardSequenceResource'. See StandardSequenceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/getDefaultSequenceForEntityAttribute

GET /corePatterns/sequences/getDefaultSequenceForEntityAttribute

POST Operations

POST Sequences

Creates a new entity record.

The following elements are required:

sequenceResource

(ApiSequenceResource) The request body should contain the entity record that should be created.
See ApiSequenceResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiSequenceResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences

POST /corePatterns/sequences

PUT Operations

PUT Set IsActive Sequence

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

sequenceKey	(string) The sequence's key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/{sequenceKey}/isActive

PUT /corePatterns/sequences/{sequenceKey}/isActive

PUT Set IsDefault Sequence

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

sequenceKey	(string) The sequence's key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/{sequenceKey}/isDefault

PUT /corePatterns/sequences/{sequenceKey}/isDefault

DELETE Operations

DELETE Sequence by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/{id}

DELETE /corePatterns/sequences/{id}

DELETE Sequence by key

Deletes the entity record that matches the specified key.

The following elements are required:

sequenceKey

(string) The sequence's key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/sequences/{sequenceKey}

DELETE /corePatterns/sequences/{sequenceKey}

Resources

ApiSequenceResource

The following elements are required:

entity	(string) The sequence’s entity.
entityAttribute	(string) The sequence’s entity attribute.
isDefault	(bool) Indicates whether this sequence is default.
sequenceKey	(string) The sequence's key.
description	(string) The sequence's description.

The following elements are optional:

sampleText	(string) The sequence's sample text.
charactersUsed	(string) The characters used.
sequenceLines	(List of ApiSequenceSequenceLinesResource) The sequence’s elements. See ApiSequenceSequenceLinesResource.

ApiSequenceSequenceLinesResource

The following elements are required:

isReadOnly	(bool) Indicates whether the segment is read-only.
isRequired	(bool) Indicates whether the segment is required.
segmentType	(enum SequenceSegmentType) The segment's type. See SequenceSegmentType.

The following elements are optional:

entity	(string) The entity for the sequence line.
entityAttribute	(string) The entity attribute for the sequence line.
length	(int) The segment length.
constantText	(string) The constant text.
lowerNumber	(int) The lower number.
separatorType	(enum SequenceSeparatorType) The separator's type. See SequenceSeparatorType.
fixedDigits	(int) The fixed digits.
suggestedNumber	(int) The suggested number.
sequenceEntityAttributeName	(string) The name of the attribute of the entity whose key is being defined as sequence.
lookupAttributeName	(string) The name for the lookup attribute.
applyToSequentialNumber	(bool) Indicates whether the segment value will be used as sequential number segment group.

SequenceResource

The following elements are required:

entity	(string) The sequence’s entity. (fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
entityAttribute	(string) The sequence’s entity attribute. (fk) Allowed value: the natural key of a record of type SchemaAttribute. These records are accessibly through the SchemaAttributes service.
isDefault	(bool) Indicates whether this sequence is default.
sequenceKey	(string) The sequence's key.
description	(string) The sequence's description.

The following elements are optional:

sampleText	(string) The sequence's sample text.
charactersUsed	(string) The characters used.
sequenceLines	(List of SequenceLineResource) The sequence’s elements. See SequenceLineResource.

StandardSequenceResource

The following elements are required:

description	(string) The sequence's description.
entity	(string) The sequence’s entity.
entityAttribute	(string) The sequence’s entity attribute.
sequenceKey	(string) The sequence's key.
isDefault	(bool) Indicates whether this sequence is default.

The following elements are optional:

charactersUsed	(string) The characters used.
sampleText	(string) The sequence's sample text.
sequenceLines	(List of StandardSequenceSequenceLinesResource) The sequence’s elements. See StandardSequenceSequenceLinesResource.

StandardSequenceSequenceLinesResource

The following elements are required:

segmentType

(enum SequenceSegmentType) The segment's type.
See SequenceSegmentType.

The following elements are optional:

applyToSequentialNumber	(bool) Indicates whether the segment value will be used as sequential number segment group.
constantText	(string) The constant text.
entity	(string) The entity for the sequence line.
entityAttribute	(string) The entity attribute for the sequence line.
fixedDigits	(int) The fixed digits.
length	(int) The segment length.
lookupAttributeName	(string) The name for the lookup attribute.
lowerNumber	(int) The lower number.
separatorType	(enum SequenceSeparatorType) The separator's type. See SequenceSeparatorType.
sequenceEntityAttributeName	(string) The name of the attribute of the entity whose key is being defined as sequence.
suggestedNumber	(int) The suggested number.

Enumerations

SequenceSegmentType

1	Entity	Entity.
2	ConstantText	StaticName.
3	SequentialNumber	AutoIncrement.
4	Separator	Separator.

SequenceSeparatorType

1	Dash
2	Underscore