Back to PipelinerAccountRelationLabels.create
Creates new accountrelationlabel
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of accountrelationlabel on create. Use them
as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 -
allows to override readonly fields,
16 - allows to set entity on deleted relationship.
title: Parameters
data:
required:
- account_relation
- account_relation_id
- account_relation_type_id
properties:
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
account_relation:
type: object
description: >-
Relation to AccountRelation, see: 'createAccountRelationInput' object
for properties.
properties:
id:
type: string
format: uri
account_relation_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
account_relation_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
type: object
title: Data
Output
type: object
properties:
success:
type: boolean
example: true
description: True when response succeeded, false on error.
data:
required:
- is_delete_protected
- id
- account_relation
- account_relation_type
- account_relation_id
- account_relation_type_id
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
account_relation:
type: string
format: uri
description: >-
Relation to AccountRelation. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'AccountRelation' object for properties.
account_relation_type:
type: string
format: uri
description: >-
Relation to AccountRelationType. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'AccountRelationType' object for properties.
account_relation_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
account_relation_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
type: object