GraphQL RepositoriescountryCrm

`entities.countryCrm`

Read country crm records with the countryCrm repository, and change them with the country crm mutations. Same records as the REST CountryCrms entity.

Example: first three country crm recordsGraphQLcURL

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

Queries

Fields of entities { countryCrm { … } }.

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.	CountryCrmEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CountryCrmEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CountryCrmFilterInput, orderBy: [CountryCrmOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CountryCrmEntity!]!
QUERY	`getByCriteria`(filter: CountryCrmFilterInput, orderBy: [CountryCrmOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CountryCrmEntityConnection
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	`createCountryCrm`(input: CreateCountryCrmInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCountryCrmPayload
MUTATION	`updateCountryCrm`(input: UpdateCountryCrmInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCountryCrmPayload
MUTATION	`bulkUpdateCountryCrm`(input: [CreateOrUpdateCountryCrmInput!]!, deleteInput: [DeleteCountryCrmInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCountryCrmPayload
MUTATION	`deleteCountryCrm`(input: DeleteCountryCrmInput!)	Soft-delete	DeleteCountryCrmPayload

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.

CountryCrmEntity object 9 fields: isDeleteProtected, id, isDeleted, …

Country offered in address fields; a new country value on a record must match one of these countries.

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.
`name`	String!	Name of the entity and its default text representation.
`useLang`	Boolean	Whether the country name is a localization key to be translated into the user language rather than displayed verbatim.
`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.

CountryCrmEntityConnection object pageInfo: PageInfo!, edges: [CountryCrmEntityEdge]!, totalCount: Int

Paginated list of CountryCrm records.

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

CountryCrmEntityEdge object node: CountryCrmEntity, cursor: String!

A Relay edge containing a CountryCrmEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CountryCrmFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CountryCrmFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CountryCrmFilterInput	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.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`useLang`	Boolean	Whether the country name is a localization key to be translated into the user language rather than displayed verbatim.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

CountryCrmOrderByInput input Asc or Desc per field

Sorting of CountryCrm 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.
`name`	OrderByEnum	Name of the entity and its default text representation.
`useLang`	OrderByEnum	Whether the country name is a localization key to be translated into the user language rather than displayed verbatim.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateCountryCrmInput input 6 fields: clientMutationId, modified, created, …

Field values of a new CountryCrm 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.
`name`	String!	Name of the entity and its default text representation.
`useLang`	Boolean	Whether the country name is a localization key to be translated into the user language rather than displayed verbatim.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateCountryCrmInput input 7 fields: clientMutationId, id, modified, …

Field values of a CountryCrm 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.
`name`	String	Name of the entity and its default text representation.
`useLang`	Boolean	Whether the country name is a localization key to be translated into the user language rather than displayed verbatim.
`revision`	Int	Revision when entity was lastly changed.

DeleteCountryCrmInput input clientMutationId: String, id: ID!

Id of the CountryCrm 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.

UpdateCountryCrmInput input 7 fields: clientMutationId, id, modified, …

Id of a CountryCrm 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.
`name`	String	Name of the entity and its default text representation.
`useLang`	Boolean	Whether the country name is a localization key to be translated into the user language rather than displayed verbatim.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCountryCrmPayload object result: BulkUpdateResults!

Result of the bulkUpdateCountryCrm mutation.

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

CreateCountryCrmPayload object countryCrm: CountryCrmEntity, clientMutationId: String

Result of the createCountryCrm mutation.

Field	Type	Description
`countryCrm`	CountryCrmEntity	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).

DeleteCountryCrmPayload object countryCrm: CountryCrmEntity, clientMutationId: String

Result of the deleteCountryCrm mutation.

Field	Type	Description
`countryCrm`	CountryCrmEntity	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).

UpdateCountryCrmPayload object countryCrm: CountryCrmEntity, clientMutationId: String

Result of the updateCountryCrm mutation.

Field	Type	Description
`countryCrm`	CountryCrmEntity	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).