GraphQLRepositoriesleadOpptySharingSalesUnitRelation
entities.leadOpptySharingSalesUnitRelation
Read lead oppty sharing sales unit relation records with the leadOpptySharingSalesUnitRelation repository, and change them with the lead oppty sharing sales unit relation mutations. Same records as the REST LeadOpptySharingSalesUnitRelations entity.
Queries
Fields of entities { leadOpptySharingSalesUnitRelation { … } }.
| 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. | LeadOpptySharingSalesUnitRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [LeadOpptySharingSalesUnitRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: LeadOpptySharingSalesUnitRelationFilterInput, orderBy: [LeadOpptySharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [LeadOpptySharingSalesUnitRelationEntity!]! |
| QUERY | getByCriteria(filter: LeadOpptySharingSalesUnitRelationFilterInput, orderBy: [LeadOpptySharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | LeadOpptySharingSalesUnitRelationEntityConnection |
| 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 | createLeadOpptySharingSalesUnitRelation(input: CreateLeadOpptySharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateLeadOpptySharingSalesUnitRelationPayload |
| MUTATION | updateLeadOpptySharingSalesUnitRelation(input: UpdateLeadOpptySharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateLeadOpptySharingSalesUnitRelationPayload |
| MUTATION | bulkUpdateLeadOpptySharingSalesUnitRelation(input: [CreateOrUpdateLeadOpptySharingSalesUnitRelationInput!]!, deleteInput: [DeleteLeadOpptySharingSalesUnitRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateLeadOpptySharingSalesUnitRelationPayload |
| MUTATION | deleteLeadOpptySharingSalesUnitRelation(input: DeleteLeadOpptySharingSalesUnitRelationInput!) | Soft-delete | DeleteLeadOpptySharingSalesUnitRelationPayload |
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.
LeadOpptySharingSalesUnitRelationEntity object 13 fields: isDeleteProtected, id, isDeleted, …
Share of a lead or opportunity with a sales unit, 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. |
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. |
unit | SalesUnitEntity | Sales unit the lead or opportunity is shared with. |
leadOpptyId | ID! | Id of the lead or opportunity being shared. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. |
unitId | ID! | Id of the sales unit. |
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. |
LeadOpptySharingSalesUnitRelationEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptySharingSalesUnitRelationEntityEdge]!, totalCount: Int
Paginated list of LeadOpptySharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [LeadOpptySharingSalesUnitRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
LeadOpptySharingSalesUnitRelationEntityEdge object node: LeadOpptySharingSalesUnitRelationEntity, cursor: String!
A Relay edge containing a LeadOpptySharingSalesUnitRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | LeadOpptySharingSalesUnitRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
LeadOpptySharingSalesUnitRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for LeadOpptySharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [LeadOpptySharingSalesUnitRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [LeadOpptySharingSalesUnitRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | LeadOpptySharingSalesUnitRelationFilterInput | 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. |
leadOpptyId | EntityFilterStringField | Id of the lead or opportunity being shared. |
role | SharingRoleEnumFilterInput | Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. |
unitId | EntityFilterStringField | Id of the sales unit. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
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. |
unit | SalesUnitFilterInput | Sales unit the lead or opportunity is shared with. Matches records where a related record meets these conditions. |
LeadOpptySharingSalesUnitRelationOrderByInput input Asc or Desc per field
Sorting of LeadOpptySharingSalesUnitRelation 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. |
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. |
unit | [SalesUnitOrderByNestedInput!] | Sales unit the lead or opportunity is shared with. Sorts by fields of the related record, listed in order of priority. |
leadOpptyId | OrderByEnum | Id of the lead or opportunity being shared. |
role | OrderByEnum | Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. |
unitId | OrderByEnum | Id of the sales unit. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateLeadOpptySharingSalesUnitRelationInput input 7 fields: clientMutationId, modified, created, …
Field values of a new LeadOpptySharingSalesUnitRelation 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. |
leadOpptyId | ID! | Id of the lead or opportunity being shared. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. |
unitId | ID! | Id of the sales unit. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateLeadOpptySharingSalesUnitRelationInput input 8 fields: clientMutationId, id, modified, …
Field values of a LeadOpptySharingSalesUnitRelation 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. |
leadOpptyId | ID | Id of the lead or opportunity being shared. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. |
unitId | ID | Id of the sales unit. |
revision | Int | Revision when entity was lastly changed. |
DeleteLeadOpptySharingSalesUnitRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID
Id of the LeadOpptySharingSalesUnitRelation 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. |
UpdateLeadOpptySharingSalesUnitRelationInput input 8 fields: clientMutationId, id, modified, …
Id of a LeadOpptySharingSalesUnitRelation 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. |
leadOpptyId | ID | Id of the lead or opportunity being shared. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it. |
unitId | ID | Id of the sales unit. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateLeadOpptySharingSalesUnitRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateLeadOpptySharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateLeadOpptySharingSalesUnitRelationPayload object leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationEntity, clientMutationId: String
Result of the createLeadOpptySharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptySharingSalesUnitRelation | LeadOpptySharingSalesUnitRelationEntity | 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). |
DeleteLeadOpptySharingSalesUnitRelationPayload object leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationEntity, clientMutationId: String
Result of the deleteLeadOpptySharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptySharingSalesUnitRelation | LeadOpptySharingSalesUnitRelationEntity | 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). |
UpdateLeadOpptySharingSalesUnitRelationPayload object leadOpptySharingSalesUnitRelation: LeadOpptySharingSalesUnitRelationEntity, clientMutationId: String
Result of the updateLeadOpptySharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptySharingSalesUnitRelation | LeadOpptySharingSalesUnitRelationEntity | 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). |