Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

FieldSequences.get

Returns fieldsequence with given id

Input

type: object properties: parameters: type: object properties: id: type: string format: uuid description: ID of fieldsequence to retrieve required: - id title: Parameters

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: required: - is_delete_protected - id - pattern properties: is_delete_protected: type: boolean example: false description: >- Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Creation time. readOnly: true pattern: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. type: object