GraphQL RepositoriesleadOpptySharingClientRelation

`entities.leadOpptySharingClientRelation`

Read lead oppty sharing client relation records with the leadOpptySharingClientRelation repository, and change them with the lead oppty sharing client relation mutations. Same records as the REST LeadOpptySharingClientRelations entity.

Example: first three lead oppty sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { leadOpptySharingClientRelation { … } }.

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.	LeadOpptySharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadOpptySharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadOpptySharingClientRelationFilterInput, orderBy: [LeadOpptySharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadOpptySharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: LeadOpptySharingClientRelationFilterInput, orderBy: [LeadOpptySharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadOpptySharingClientRelationEntityConnection
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	`createLeadOpptySharingClientRelation`(input: CreateLeadOpptySharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateLeadOpptySharingClientRelationPayload
MUTATION	`updateLeadOpptySharingClientRelation`(input: UpdateLeadOpptySharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateLeadOpptySharingClientRelationPayload
MUTATION	`bulkUpdateLeadOpptySharingClientRelation`(input: [CreateOrUpdateLeadOpptySharingClientRelationInput!]!, deleteInput: [DeleteLeadOpptySharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateLeadOpptySharingClientRelationPayload
MUTATION	`deleteLeadOpptySharingClientRelation`(input: DeleteLeadOpptySharingClientRelationInput!)	Soft-delete	DeleteLeadOpptySharingClientRelationPayload

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.

LeadOpptySharingClientRelationEntity object 13 fields: isDeleteProtected, id, isDeleted, …

Share of a lead or opportunity with an individual user, with the access level granted.

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.
`client`	ClientEntity	User the lead or opportunity is shared with.
`lead`	LeadEntity	Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty.
`oppty`	OpportunityEntity	Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty.
`clientId`	ID!	Id of the user.
`leadOpptyId`	ID!	Id of the lead or opportunity being shared.
`role`	SharingRoleEnum	Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
`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.

LeadOpptySharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptySharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of LeadOpptySharingClientRelation records.

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

LeadOpptySharingClientRelationEntityEdge object node: LeadOpptySharingClientRelationEntity, cursor: String!

A Relay edge containing a LeadOpptySharingClientRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[LeadOpptySharingClientRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[LeadOpptySharingClientRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	LeadOpptySharingClientRelationFilterInput	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.
`clientId`	EntityFilterStringField	Id of the user.
`leadOpptyId`	EntityFilterStringField	Id of the lead or opportunity being shared.
`role`	SharingRoleEnumFilterInput	Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User the lead or opportunity is shared with. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions.

LeadOpptySharingClientRelationOrderByInput input Asc or Desc per field

Sorting of LeadOpptySharingClientRelation 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.
`client`	[ClientOrderByNestedInput!]	User the lead or opportunity is shared with. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`leadOpptyId`	OrderByEnum	Id of the lead or opportunity being shared.
`role`	OrderByEnum	Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new LeadOpptySharingClientRelation 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.
`clientId`	ID!	Id of the user.
`leadOpptyId`	ID!	Id of the lead or opportunity being shared.
`role`	SharingRoleEnum	Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a LeadOpptySharingClientRelation 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.
`clientId`	ID	Id of the user.
`leadOpptyId`	ID	Id of the lead or opportunity being shared.
`role`	SharingRoleEnum	Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

DeleteLeadOpptySharingClientRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID

Id of the LeadOpptySharingClientRelation 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.
`leadOpptyId`	ID	Id of the lead or opportunity being shared.

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

Id of a LeadOpptySharingClientRelation 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.
`clientId`	ID	Id of the user.
`leadOpptyId`	ID	Id of the lead or opportunity being shared.
`role`	SharingRoleEnum	Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateLeadOpptySharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateLeadOpptySharingClientRelation mutation.

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

CreateLeadOpptySharingClientRelationPayload object leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity, clientMutationId: String

Result of the createLeadOpptySharingClientRelation mutation.

Field	Type	Description
`leadOpptySharingClientRelation`	LeadOpptySharingClientRelationEntity	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).

DeleteLeadOpptySharingClientRelationPayload object leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity, clientMutationId: String

Result of the deleteLeadOpptySharingClientRelation mutation.

Field	Type	Description
`leadOpptySharingClientRelation`	LeadOpptySharingClientRelationEntity	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).

UpdateLeadOpptySharingClientRelationPayload object leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity, clientMutationId: String

Result of the updateLeadOpptySharingClientRelation mutation.

Field	Type	Description
`leadOpptySharingClientRelation`	LeadOpptySharingClientRelationEntity	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).