GraphQL RepositoriesclientExcludedOppty

`entities.clientExcludedOppty`

Read client excluded oppty records with the clientExcludedOppty repository, and change them with the client excluded oppty mutations. Same records as the REST ClientExcludedOppties entity.

Example: first three client excluded oppty recordsGraphQLcURL

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

Queries

Fields of entities { clientExcludedOppty { … } }.

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.	ClientExcludedOpptyEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ClientExcludedOpptyEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ClientExcludedOpptyFilterInput, orderBy: [ClientExcludedOpptyOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ClientExcludedOpptyEntity!]!
QUERY	`getByCriteria`(filter: ClientExcludedOpptyFilterInput, orderBy: [ClientExcludedOpptyOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ClientExcludedOpptyEntityConnection
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	`isOpptyExcluded`(opptyId: UUID!, ownerId: UUID) Returns true when the user has excluded the opportunity from their forecast and quota calculations.	Boolean!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createClientExcludedOppty`(input: CreateClientExcludedOpptyInput!, validationLevel: [ValidationLevel!])	Create one record	CreateClientExcludedOpptyPayload
MUTATION	`updateClientExcludedOppty`(input: UpdateClientExcludedOpptyInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateClientExcludedOpptyPayload
MUTATION	`bulkUpdateClientExcludedOppty`(input: [CreateOrUpdateClientExcludedOpptyInput!]!, deleteInput: [DeleteClientExcludedOpptyInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateClientExcludedOpptyPayload
MUTATION	`deleteClientExcludedOppty`(input: DeleteClientExcludedOpptyInput!)	Soft-delete	DeleteClientExcludedOpptyPayload

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.

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

Choice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again.

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.
`oppty`	OpportunityEntity	Opportunity excluded from the user's forecast/quota calculations.
`owner`	ClientEntity	User who excluded the opportunity from their forecast/quota.
`isExcluded`	Boolean!	When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity.
`opptyId`	ID!	Id of the opportunity.
`ownerId`	ID!	Id of the user.
`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.

ClientExcludedOpptyEntityConnection object pageInfo: PageInfo!, edges: [ClientExcludedOpptyEntityEdge]!, totalCount: Int

Paginated list of ClientExcludedOppty records.

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

ClientExcludedOpptyEntityEdge object node: ClientExcludedOpptyEntity, cursor: String!

A Relay edge containing a ClientExcludedOpptyEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ClientExcludedOpptyFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ClientExcludedOpptyFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ClientExcludedOpptyFilterInput	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.
`isExcluded`	Boolean	When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity.
`opptyId`	EntityFilterStringField	Id of the opportunity.
`ownerId`	EntityFilterStringField	Id of the user.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`oppty`	OpportunityFilterInput	Opportunity excluded from the user's forecast/quota calculations. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	User who excluded the opportunity from their forecast/quota. Matches records where a related record meets these conditions.

ClientExcludedOpptyOrderByInput input Asc or Desc per field

Sorting of ClientExcludedOppty 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.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity excluded from the user's forecast/quota calculations. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	User who excluded the opportunity from their forecast/quota. Sorts by fields of the related record, listed in order of priority.
`isExcluded`	OrderByEnum	When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity.
`opptyId`	OrderByEnum	Id of the opportunity.
`ownerId`	OrderByEnum	Id of the user.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateClientExcludedOpptyInput input 7 fields: clientMutationId, modified, created, …

Field values of a new ClientExcludedOppty 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.
`isExcluded`	Boolean!	When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity.
`opptyId`	ID!	Id of the opportunity.
`ownerId`	ID!	Id of the user.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateClientExcludedOpptyInput input 8 fields: clientMutationId, id, modified, …

Field values of a ClientExcludedOppty 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.
`isExcluded`	Boolean	When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity.
`opptyId`	ID	Id of the opportunity.
`ownerId`	ID	Id of the user.
`revision`	Int	Revision when entity was lastly changed.

DeleteClientExcludedOpptyInput input clientMutationId: String, id: ID!

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

UpdateClientExcludedOpptyInput input 8 fields: clientMutationId, id, modified, …

Id of a ClientExcludedOppty 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.
`isExcluded`	Boolean	When true, the opportunity is excluded from the user's forecast/quota; when false, the row records that the user explicitly re-included a previously excluded opportunity.
`opptyId`	ID	Id of the opportunity.
`ownerId`	ID	Id of the user.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateClientExcludedOpptyPayload object result: BulkUpdateResults!

Result of the bulkUpdateClientExcludedOppty mutation.

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

CreateClientExcludedOpptyPayload object clientExcludedOppty: ClientExcludedOpptyEntity, clientMutationId: String

Result of the createClientExcludedOppty mutation.

Field	Type	Description
`clientExcludedOppty`	ClientExcludedOpptyEntity	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).

DeleteClientExcludedOpptyPayload object clientExcludedOppty: ClientExcludedOpptyEntity, clientMutationId: String

Result of the deleteClientExcludedOppty mutation.

Field	Type	Description
`clientExcludedOppty`	ClientExcludedOpptyEntity	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).

UpdateClientExcludedOpptyPayload object clientExcludedOppty: ClientExcludedOpptyEntity, clientMutationId: String

Result of the updateClientExcludedOppty mutation.

Field	Type	Description
`clientExcludedOppty`	ClientExcludedOpptyEntity	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).