GraphQL RepositoriesallowedLeadType

`entities.allowedLeadType`

Read allowed lead type records with the allowedLeadType repository, and change them with the allowed lead type mutations. Same records as the REST AllowedLeadTypes entity.

Example: first three allowed lead type recordsGraphQLcURL

query FirstAllowedLeadTypes {
  entities {
    allowedLeadType {
      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 FirstAllowedLeadTypes { entities { allowedLeadType { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { allowedLeadType { … } }.

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.	AllowedLeadTypeEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AllowedLeadTypeEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AllowedLeadTypeFilterInput, orderBy: [AllowedLeadTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AllowedLeadTypeEntity!]!
QUERY	`getByCriteria`(filter: AllowedLeadTypeFilterInput, orderBy: [AllowedLeadTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AllowedLeadTypeEntityConnection
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!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createAllowedLeadType`(input: CreateAllowedLeadTypeInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAllowedLeadTypePayload
MUTATION	`updateAllowedLeadType`(input: UpdateAllowedLeadTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAllowedLeadTypePayload
MUTATION	`bulkUpdateAllowedLeadType`(input: [CreateOrUpdateAllowedLeadTypeInput!]!, deleteInput: [DeleteAllowedLeadTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAllowedLeadTypePayload
MUTATION	`deleteAllowedLeadType`(input: DeleteAllowedLeadTypeInput!)	Soft-delete	DeleteAllowedLeadTypePayload

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.

AllowedLeadTypeEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Lead type that a user role is allowed to use.

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.
`leadType`	LeadTypeEntity	Lead type the user role can use.
`masterRight`	MasterRightEntity	User role granted access to the lead type.
`leadTypeId`	ID!	Id of the lead type the user role can use.
`masterRightId`	ID!	Id of the user role.
`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.

AllowedLeadTypeEntityConnection object pageInfo: PageInfo!, edges: [AllowedLeadTypeEntityEdge]!, totalCount: Int

Paginated list of AllowedLeadType records.

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

AllowedLeadTypeEntityEdge object node: AllowedLeadTypeEntity, cursor: String!

A Relay edge containing a AllowedLeadTypeEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[AllowedLeadTypeFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AllowedLeadTypeFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AllowedLeadTypeFilterInput	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.
`leadTypeId`	EntityFilterStringField	Id of the lead type the user role can use.
`masterRightId`	EntityFilterStringField	Id of the user role.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`leadType`	LeadTypeFilterInput	Lead type the user role can use. Matches records where a related record meets these conditions.
`masterRight`	MasterRightFilterInput	User role granted access to the lead type. Matches records where a related record meets these conditions.

AllowedLeadTypeOrderByInput input Asc or Desc per field

Sorting of AllowedLeadType 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.
`leadType`	[LeadTypeOrderByNestedInput!]	Lead type the user role can use. Sorts by fields of the related record, listed in order of priority.
`masterRight`	[MasterRightOrderByNestedInput!]	User role granted access to the lead type. Sorts by fields of the related record, listed in order of priority.
`leadTypeId`	OrderByEnum	Id of the lead type the user role can use.
`masterRightId`	OrderByEnum	Id of the user role.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateAllowedLeadTypeInput input 6 fields: clientMutationId, modified, created, …

Field values of a new AllowedLeadType record.

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).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`leadTypeId`	ID!	Id of the lead type the user role can use.
`masterRightId`	ID!	Id of the user role.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateAllowedLeadTypeInput input 7 fields: clientMutationId, id, modified, …

Field values of an AllowedLeadType 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.
`leadTypeId`	ID	Id of the lead type the user role can use.
`masterRightId`	ID	Id of the user role.
`revision`	Int	Revision when entity was lastly changed.

DeleteAllowedLeadTypeInput input clientMutationId: String, id: ID!

Id of the AllowedLeadType 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.

UpdateAllowedLeadTypeInput input 7 fields: clientMutationId, id, modified, …

Id of an AllowedLeadType 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.
`leadTypeId`	ID	Id of the lead type the user role can use.
`masterRightId`	ID	Id of the user role.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAllowedLeadTypePayload object result: BulkUpdateResults!

Result of the bulkUpdateAllowedLeadType mutation.

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

CreateAllowedLeadTypePayload object allowedLeadType: AllowedLeadTypeEntity, clientMutationId: String

Result of the createAllowedLeadType mutation.

Field	Type	Description
`allowedLeadType`	AllowedLeadTypeEntity	The created 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).

DeleteAllowedLeadTypePayload object allowedLeadType: AllowedLeadTypeEntity, clientMutationId: String

Result of the deleteAllowedLeadType mutation.

Field	Type	Description
`allowedLeadType`	AllowedLeadTypeEntity	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).

UpdateAllowedLeadTypePayload object allowedLeadType: AllowedLeadTypeEntity, clientMutationId: String

Result of the updateAllowedLeadType mutation.

Field	Type	Description
`allowedLeadType`	AllowedLeadTypeEntity	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).