GraphQLRepositoriesallowedContactType
entities.allowedContactType
Read allowed contact type records with the allowedContactType repository, and change them with the allowed contact type mutations. Same records as the REST AllowedContactTypes entity.
Queries
Fields of entities { allowedContactType { … } }.
| 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. | AllowedContactTypeEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [AllowedContactTypeEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: AllowedContactTypeFilterInput, orderBy: [AllowedContactTypeOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [AllowedContactTypeEntity!]! |
| QUERY | getByCriteria(filter: AllowedContactTypeFilterInput, orderBy: [AllowedContactTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | AllowedContactTypeEntityConnection |
| 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 | createAllowedContactType(input: CreateAllowedContactTypeInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateAllowedContactTypePayload |
| MUTATION | updateAllowedContactType(input: UpdateAllowedContactTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateAllowedContactTypePayload |
| MUTATION | bulkUpdateAllowedContactType(input: [CreateOrUpdateAllowedContactTypeInput!]!, deleteInput: [DeleteAllowedContactTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateAllowedContactTypePayload |
| MUTATION | deleteAllowedContactType(input: DeleteAllowedContactTypeInput!) | Soft-delete | DeleteAllowedContactTypePayload |
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.
AllowedContactTypeEntity object 11 fields: isDeleteProtected, id, isDeleted, …
Contact type that a user role is allowed to use.
| 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. |
contactType | ContactTypeEntity | Contact type the user role can use. |
masterRight | MasterRightEntity | User role granted access to the contact type. |
contactTypeId | ID! | Id of the contact type the user role can use. |
masterRightId | ID! | Id of the user role. |
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. |
AllowedContactTypeEntityConnection object pageInfo: PageInfo!, edges: [AllowedContactTypeEntityEdge]!, totalCount: Int
Paginated list of AllowedContactType records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [AllowedContactTypeEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
AllowedContactTypeEntityEdge object node: AllowedContactTypeEntity, cursor: String!
A Relay edge containing a AllowedContactTypeEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | AllowedContactTypeEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
AllowedContactTypeFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for AllowedContactType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [AllowedContactTypeFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [AllowedContactTypeFilterInput!] | Matches records that meet all of the listed filters. |
NOT | AllowedContactTypeFilterInput | 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. |
contactTypeId | EntityFilterStringField | Id of the contact type the user role can use. |
masterRightId | EntityFilterStringField | Id of the user role. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
contactType | ContactTypeFilterInput | Contact type the user role can use. Matches records where a related record meets these conditions. |
masterRight | MasterRightFilterInput | User role granted access to the contact type. Matches records where a related record meets these conditions. |
AllowedContactTypeOrderByInput input Asc or Desc per field
Sorting of AllowedContactType 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. |
contactType | [ContactTypeOrderByNestedInput!] | Contact type the user role can use. Sorts by fields of the related record, listed in order of priority. |
masterRight | [MasterRightOrderByNestedInput!] | User role granted access to the contact type. Sorts by fields of the related record, listed in order of priority. |
contactTypeId | OrderByEnum | Id of the contact type the user role can use. |
masterRightId | OrderByEnum | Id of the user role. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateAllowedContactTypeInput input 6 fields: clientMutationId, modified, created, …
Field values of a new AllowedContactType 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. |
contactTypeId | ID! | Id of the contact type the user role can use. |
masterRightId | ID! | Id of the user role. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateAllowedContactTypeInput input 7 fields: clientMutationId, id, modified, …
Field values of an AllowedContactType 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. |
contactTypeId | ID | Id of the contact type the user role can use. |
masterRightId | ID | Id of the user role. |
revision | Int | Revision when entity was lastly changed. |
DeleteAllowedContactTypeInput input clientMutationId: String, id: ID!
Id of the AllowedContactType 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. |
UpdateAllowedContactTypeInput input 7 fields: clientMutationId, id, modified, …
Id of an AllowedContactType 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. |
contactTypeId | ID | Id of the contact type the user role can use. |
masterRightId | ID | Id of the user role. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateAllowedContactTypePayload object result: BulkUpdateResults!
Result of the bulkUpdateAllowedContactType mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateAllowedContactTypePayload object allowedContactType: AllowedContactTypeEntity, clientMutationId: String
Result of the createAllowedContactType mutation.
| Field | Type | Description |
|---|---|---|
allowedContactType | AllowedContactTypeEntity | 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). |
DeleteAllowedContactTypePayload object allowedContactType: AllowedContactTypeEntity, clientMutationId: String
Result of the deleteAllowedContactType mutation.
| Field | Type | Description |
|---|---|---|
allowedContactType | AllowedContactTypeEntity | 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). |
UpdateAllowedContactTypePayload object allowedContactType: AllowedContactTypeEntity, clientMutationId: String
Result of the updateAllowedContactType mutation.
| Field | Type | Description |
|---|---|---|
allowedContactType | AllowedContactTypeEntity | 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). |