GraphQL RepositoriessalesRole

`entities.salesRole`

Read sales role records with the salesRole repository, and change them with the sales role mutations. Same records as the REST SalesRoles entity.

Example: first three sales role recordsGraphQLcURL

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

Queries

Fields of entities { salesRole { … } }.

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.	SalesRoleEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[SalesRoleEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: SalesRoleFilterInput, orderBy: [SalesRoleOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[SalesRoleEntity!]!
QUERY	`getByCriteria`(filter: SalesRoleFilterInput, orderBy: [SalesRoleOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	SalesRoleEntityConnection
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	`createSalesRole`(input: CreateSalesRoleInput!, validationLevel: [ValidationLevel!])	Create one record	CreateSalesRolePayload
MUTATION	`updateSalesRole`(input: UpdateSalesRoleInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateSalesRolePayload
MUTATION	`bulkUpdateSalesRole`(input: [CreateOrUpdateSalesRoleInput!]!, deleteInput: [DeleteSalesRoleInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateSalesRolePayload
MUTATION	`deleteSalesRole`(input: DeleteSalesRoleInput!)	Soft-delete	DeleteSalesRolePayload

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.

SalesRoleEntity object 9 fields: isDeleteProtected, id, isDeleted, …

Role a contact plays in a deal (e.g. decision maker), assigned to contacts on leads and opportunities.

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.
`colorCode`	Int!	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String!	Name of the entity and its default text representation.
`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.

SalesRoleEntityConnection object pageInfo: PageInfo!, edges: [SalesRoleEntityEdge]!, totalCount: Int

Paginated list of SalesRole records.

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

SalesRoleEntityEdge object node: SalesRoleEntity, cursor: String!

A Relay edge containing a SalesRoleEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[SalesRoleFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[SalesRoleFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	SalesRoleFilterInput	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.
`colorCode`	EntityFilterNumberField	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

SalesRoleOrderByInput input Asc or Desc per field

Sorting of SalesRole 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.
`colorCode`	OrderByEnum	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a SalesRole 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.
`colorCode`	Int	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a new SalesRole 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.
`colorCode`	Int!	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

DeleteSalesRoleInput input clientMutationId: String, id: ID!

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

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

Id of a SalesRole 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.
`colorCode`	Int	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateSalesRolePayload object result: BulkUpdateResults!

Result of the bulkUpdateSalesRole mutation.

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

CreateSalesRolePayload object salesRole: SalesRoleEntity, clientMutationId: String

Result of the createSalesRole mutation.

Field	Type	Description
`salesRole`	SalesRoleEntity	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).

DeleteSalesRolePayload object salesRole: SalesRoleEntity, clientMutationId: String

Result of the deleteSalesRole mutation.

Field	Type	Description
`salesRole`	SalesRoleEntity	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).

UpdateSalesRolePayload object salesRole: SalesRoleEntity, clientMutationId: String

Result of the updateSalesRole mutation.

Field	Type	Description
`salesRole`	SalesRoleEntity	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).