GraphQLRepositoriesprojectSharingSalesUnitRelation
entities.projectSharingSalesUnitRelation
Read project sharing sales unit relation records with the projectSharingSalesUnitRelation repository, and change them with the project sharing sales unit relation mutations. Same records as the REST ProjectSharingSalesUnitRelations entity.
Queries
Fields of entities { projectSharingSalesUnitRelation { … } }.
| 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. | ProjectSharingSalesUnitRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [ProjectSharingSalesUnitRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: ProjectSharingSalesUnitRelationFilterInput, orderBy: [ProjectSharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [ProjectSharingSalesUnitRelationEntity!]! |
| QUERY | getByCriteria(filter: ProjectSharingSalesUnitRelationFilterInput, orderBy: [ProjectSharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | ProjectSharingSalesUnitRelationEntityConnection |
| 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 | createProjectSharingSalesUnitRelation(input: CreateProjectSharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateProjectSharingSalesUnitRelationPayload |
| MUTATION | updateProjectSharingSalesUnitRelation(input: UpdateProjectSharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateProjectSharingSalesUnitRelationPayload |
| MUTATION | bulkUpdateProjectSharingSalesUnitRelation(input: [CreateOrUpdateProjectSharingSalesUnitRelationInput!]!, deleteInput: [DeleteProjectSharingSalesUnitRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateProjectSharingSalesUnitRelationPayload |
| MUTATION | deleteProjectSharingSalesUnitRelation(input: DeleteProjectSharingSalesUnitRelationInput!) | Soft-delete | DeleteProjectSharingSalesUnitRelationPayload |
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.
ProjectSharingSalesUnitRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …
Share of a project 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. |
project | ProjectEntity | Project being shared. |
unit | SalesUnitEntity | Sales unit the project is shared with. |
projectId | ID! | Id of the shared project. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the project: 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. |
ProjectSharingSalesUnitRelationEntityConnection object pageInfo: PageInfo!, edges: [ProjectSharingSalesUnitRelationEntityEdge]!, totalCount: Int
Paginated list of ProjectSharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [ProjectSharingSalesUnitRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
ProjectSharingSalesUnitRelationEntityEdge object node: ProjectSharingSalesUnitRelationEntity, cursor: String!
A Relay edge containing a ProjectSharingSalesUnitRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | ProjectSharingSalesUnitRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
ProjectSharingSalesUnitRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for ProjectSharingSalesUnitRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [ProjectSharingSalesUnitRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [ProjectSharingSalesUnitRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | ProjectSharingSalesUnitRelationFilterInput | 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. |
projectId | EntityFilterStringField | Id of the shared project. |
role | SharingRoleEnumFilterInput | Access the sharing gives the sales unit on the project: 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. |
project | ProjectFilterInput | Project being shared. Matches records where a related record meets these conditions. |
unit | SalesUnitFilterInput | Sales unit the project is shared with. Matches records where a related record meets these conditions. |
ProjectSharingSalesUnitRelationOrderByInput input Asc or Desc per field
Sorting of ProjectSharingSalesUnitRelation 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. |
project | [ProjectOrderByNestedInput!] | Project being shared. Sorts by fields of the related record, listed in order of priority. |
unit | [SalesUnitOrderByNestedInput!] | Sales unit the project is shared with. Sorts by fields of the related record, listed in order of priority. |
projectId | OrderByEnum | Id of the shared project. |
role | OrderByEnum | Access the sharing gives the sales unit on the project: 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. |
CreateOrUpdateProjectSharingSalesUnitRelationInput input 8 fields: clientMutationId, id, modified, …
Field values of a ProjectSharingSalesUnitRelation 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. |
projectId | ID | Id of the shared project. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the project: 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. |
CreateProjectSharingSalesUnitRelationInput input 7 fields: clientMutationId, modified, created, …
Field values of a new ProjectSharingSalesUnitRelation 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. |
projectId | ID! | Id of the shared project. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the project: 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. |
DeleteProjectSharingSalesUnitRelationInput input clientMutationId: String, id: ID!
Id of the ProjectSharingSalesUnitRelation 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. |
UpdateProjectSharingSalesUnitRelationInput input 8 fields: clientMutationId, id, modified, …
Id of a ProjectSharingSalesUnitRelation 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. |
projectId | ID | Id of the shared project. |
role | SharingRoleEnum | Access the sharing gives the sales unit on the project: 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. |
BulkUpdateProjectSharingSalesUnitRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateProjectSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateProjectSharingSalesUnitRelationPayload object projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationEntity, clientMutationId: String
Result of the createProjectSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
projectSharingSalesUnitRelation | ProjectSharingSalesUnitRelationEntity | 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). |
DeleteProjectSharingSalesUnitRelationPayload object projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationEntity, clientMutationId: String
Result of the deleteProjectSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
projectSharingSalesUnitRelation | ProjectSharingSalesUnitRelationEntity | 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). |
UpdateProjectSharingSalesUnitRelationPayload object projectSharingSalesUnitRelation: ProjectSharingSalesUnitRelationEntity, clientMutationId: String
Result of the updateProjectSharingSalesUnitRelation mutation.
| Field | Type | Description |
|---|---|---|
projectSharingSalesUnitRelation | ProjectSharingSalesUnitRelationEntity | 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). |