GraphQLRepositoriescontactSharingSalesUnitRelation
entities.contactSharingSalesUnitRelation
Read contact sharing sales unit relation records with the contactSharingSalesUnitRelation repository, and change them with the contact sharing sales unit relation mutations. Same records as the REST ContactSharingSalesUnitRelations entity.
Queries
Fields of entities { contactSharingSalesUnitRelation { … } }.
| 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. | ContactSharingSalesUnitRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [ContactSharingSalesUnitRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: ContactSharingSalesUnitRelationFilterInput, orderBy: [ContactSharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [ContactSharingSalesUnitRelationEntity!]! |
| QUERY | getByCriteria(filter: ContactSharingSalesUnitRelationFilterInput, orderBy: [ContactSharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | ContactSharingSalesUnitRelationEntityConnection |
| 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 | createContactSharingSalesUnitRelation(input: CreateContactSharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateContactSharingSalesUnitRelationPayload |
| MUTATION | updateContactSharingSalesUnitRelation(input: UpdateContactSharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateContactSharingSalesUnitRelationPayload |
| MUTATION | bulkUpdateContactSharingSalesUnitRelation(input: [CreateOrUpdateContactSharingSalesUnitRelationInput!]!, deleteInput: [DeleteContactSharingSalesUnitRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateContactSharingSalesUnitRelationPayload |
| MUTATION | deleteContactSharingSalesUnitRelation(input: DeleteContactSharingSalesUnitRelationInput!) | Soft-delete | DeleteContactSharingSalesUnitRelationPayload |
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.
ContactSharingSalesUnitRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …
Sharing of a contact with a sales unit, as a watcher or an editor.
| 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. |
contact | ContactEntity | Contact being shared. |
unit | SalesUnitEntity | Sales unit the contact is shared with. |
contactId | ID! | Id of the shared contact. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the contact: 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. |
ContactSharingSalesUnitRelationEntityConnection object pageInfo: PageInfo!, edges: [ContactSharingSalesUnitRelationEntityEdge]!, totalCount: Int
Paginated list of ContactSharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [ContactSharingSalesUnitRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
ContactSharingSalesUnitRelationEntityEdge object node: ContactSharingSalesUnitRelationEntity, cursor: String!
A Relay edge containing a ContactSharingSalesUnitRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | ContactSharingSalesUnitRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
ContactSharingSalesUnitRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for ContactSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [ContactSharingSalesUnitRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [ContactSharingSalesUnitRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | ContactSharingSalesUnitRelationFilterInput | 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. |
contactId | EntityFilterStringField | Id of the shared contact. |
role | SharingRoleEnumFilterInput | Access the sharing gives the sales unit on the contact: 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. |
contact | ContactFilterInput | Contact being shared. Matches records where a related record meets these conditions. |
unit | SalesUnitFilterInput | Sales unit the contact is shared with. Matches records where a related record meets these conditions. |
ContactSharingSalesUnitRelationOrderByInput input Asc or Desc per field
Sorting of ContactSharingSalesUnitRelation 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. |
contact | [ContactOrderByNestedInput!] | Contact being shared. Sorts by fields of the related record, listed in order of priority. |
unit | [SalesUnitOrderByNestedInput!] | Sales unit the contact is shared with. Sorts by fields of the related record, listed in order of priority. |
contactId | OrderByEnum | Id of the shared contact. |
role | OrderByEnum | Access the sharing gives the sales unit on the contact: 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. |
CreateContactSharingSalesUnitRelationInput input 7 fields: clientMutationId, modified, created, …
Field values of a new ContactSharingSalesUnitRelation 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. |
contactId | ID! | Id of the shared contact. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the contact: 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. |
CreateOrUpdateContactSharingSalesUnitRelationInput input 8 fields: clientMutationId, id, modified, …
Field values of a ContactSharingSalesUnitRelation 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. |
contactId | ID | Id of the shared contact. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the contact: 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. |
DeleteContactSharingSalesUnitRelationInput input clientMutationId: String, id: ID!
Id of the ContactSharingSalesUnitRelation 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. |
UpdateContactSharingSalesUnitRelationInput input 8 fields: clientMutationId, id, modified, …
Id of a ContactSharingSalesUnitRelation 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. |
contactId | ID | Id of the shared contact. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the contact: 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. |
BulkUpdateContactSharingSalesUnitRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateContactSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateContactSharingSalesUnitRelationPayload object contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationEntity, clientMutationId: String
Result of the createContactSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
contactSharingSalesUnitRelation | ContactSharingSalesUnitRelationEntity | 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). |
DeleteContactSharingSalesUnitRelationPayload object contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationEntity, clientMutationId: String
Result of the deleteContactSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
contactSharingSalesUnitRelation | ContactSharingSalesUnitRelationEntity | 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). |
UpdateContactSharingSalesUnitRelationPayload object contactSharingSalesUnitRelation: ContactSharingSalesUnitRelationEntity, clientMutationId: String
Result of the updateContactSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
contactSharingSalesUnitRelation | ContactSharingSalesUnitRelationEntity | 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). |