GraphQL RepositoriescloudObjectStepRelation

`entities.cloudObjectStepRelation`

Read cloud object step relation records with the cloudObjectStepRelation repository, and change them with the cloud object step relation mutations. Same records as the REST CloudObjectStepRelations entity.

Example: first three cloud object step relation recordsGraphQLcURL

query FirstCloudObjectStepRelations {
  entities {
    cloudObjectStepRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstCloudObjectStepRelations { entities { cloudObjectStepRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { cloudObjectStepRelation { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	CloudObjectStepRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CloudObjectStepRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CloudObjectStepRelationFilterInput, orderBy: [CloudObjectStepRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CloudObjectStepRelationEntity!]!
QUERY	`getByCriteria`(filter: CloudObjectStepRelationFilterInput, orderBy: [CloudObjectStepRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CloudObjectStepRelationEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!
QUERY	`getByStepId`(stepId: UUID!) Returns the files attached to the pipeline step, in their display order.	[CloudObjectStepRelationEntity!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`updateCloudObjectStepRelation`(input: UpdateCloudObjectStepRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCloudObjectStepRelationPayload
MUTATION	`bulkUpdateCloudObjectStepRelation`(input: [CreateOrUpdateCloudObjectStepRelationInput!]!, deleteInput: [DeleteCloudObjectStepRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCloudObjectStepRelationPayload
MUTATION	`deleteCloudObjectStepRelation`(input: DeleteCloudObjectStepRelationInput!)	Soft-delete	DeleteCloudObjectStepRelationPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

CloudObjectStepRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

File attached to a pipeline step, such as a document the sales team uses in that step.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`cloudObject`	CloudObjectEntity	File attached to the step.
`step`	StepEntity	Pipeline step the file is attached to.
`cloudObjectId`	ID	Id of the attached file.
`sortOrder`	Int	Position of the file within the step's document list.
`stepId`	ID!	Id of the pipeline step.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CloudObjectStepRelationEntityConnection object pageInfo: PageInfo!, edges: [CloudObjectStepRelationEntityEdge]!, totalCount: Int

Paginated list of CloudObjectStepRelation records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[CloudObjectStepRelationEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

CloudObjectStepRelationEntityEdge object node: CloudObjectStepRelationEntity, cursor: String!

A Relay edge containing a CloudObjectStepRelationEntity and its cursor.

Field	Type	Description
`node`	CloudObjectStepRelationEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

CloudObjectStepRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for CloudObjectStepRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[CloudObjectStepRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CloudObjectStepRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CloudObjectStepRelationFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`cloudObjectId`	EntityFilterStringField	Id of the attached file.
`sortOrder`	EntityFilterNumberField	Position of the file within the step's document list.
`stepId`	EntityFilterStringField	Id of the pipeline step.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`cloudObject`	CloudObjectFilterInput	File attached to the step. Matches records where a related record meets these conditions.
`step`	StepFilterInput	Pipeline step the file is attached to. Matches records where a related record meets these conditions.

CloudObjectStepRelationOrderByInput input Asc or Desc per field

Sorting of CloudObjectStepRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`step`	[StepOrderByNestedInput!]	Pipeline step the file is attached to. Sorts by fields of the related record, listed in order of priority.
`sortOrder`	OrderByEnum	Position of the file within the step's document list.
`stepId`	OrderByEnum	Id of the pipeline step.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateCloudObjectStepRelationInput input 9 fields: clientMutationId, id, modified, …

Field values of a CloudObjectStepRelation record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`cloudObject`	CreateCloudObjectInput	File attached to the step.
`cloudObjectId`	ID	Id of the attached file.
`sortOrder`	Int	Position of the file within the step's document list.
`stepId`	ID	Id of the pipeline step.
`revision`	Int	Revision when entity was lastly changed.

DeleteCloudObjectStepRelationInput input clientMutationId: String, id: ID!

Id of the CloudObjectStepRelation record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateCloudObjectStepRelationInput input 9 fields: clientMutationId, id, modified, …

Id of a CloudObjectStepRelation record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`cloudObject`	CreateCloudObjectInput	File attached to the step.
`cloudObjectId`	ID	Id of the attached file.
`sortOrder`	Int	Position of the file within the step's document list.
`stepId`	ID	Id of the pipeline step.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCloudObjectStepRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateCloudObjectStepRelation mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

DeleteCloudObjectStepRelationPayload object cloudObjectStepRelation: CloudObjectStepRelationEntity, clientMutationId: String

Result of the deleteCloudObjectStepRelation mutation.

Field	Type	Description
`cloudObjectStepRelation`	CloudObjectStepRelationEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateCloudObjectStepRelationPayload object cloudObjectStepRelation: CloudObjectStepRelationEntity, clientMutationId: String

Result of the updateCloudObjectStepRelation mutation.

Field	Type	Description
`cloudObjectStepRelation`	CloudObjectStepRelationEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).