GraphQL Repositoriestranslation

`entities.translation`

Read translation records with the translation repository, and change them with the translation mutations. Same records as the REST Translations entity.

Example: first three translation recordsGraphQLcURL

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

Queries

Fields of entities { translation { … } }.

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.	TranslationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[TranslationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: TranslationFilterInput, orderBy: [TranslationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[TranslationEntity!]!
QUERY	`getByCriteria`(filter: TranslationFilterInput, orderBy: [TranslationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	TranslationEntityConnection
QUERY	`getPublished`(limit: Int, offset: Int, filter: TranslationFilterInput, orderBy: [TranslationOrderByInput!], includeDeleted: Boolean) Returns the published records that match the filter, paged with limit and offset.	[TranslationEntity!]!
QUERY	`getDrafts`(filter: TranslationFilterInput, orderBy: [TranslationOrderByInput!]) Returns the records that match the filter, with pending unpublished changes applied where a draft exists.	[TranslationEntity!]!
QUERY	`getDraftById`(entityId: ID!) Returns the record with the given id, with its pending unpublished changes applied when a draft exists.	TranslationEntity!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`deleteTranslation`(input: DeleteDraftTranslationInput!)	Soft-delete	DeleteTranslationPayload
MUTATION	`createTranslation`(input: CreateDraftTranslationInput!)	Create one record	CreateTranslationPayload
MUTATION	`updateTranslation`(input: UpdateDraftTranslationInput!)	Update fields	UpdateTranslationPayload

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.

TranslationEntity object 37 fields: isDeleteProtected, hasDraft, id, …

Translation of a field name, dropdown option or form text into the supported languages.

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.
`hasDraft`	Boolean	True when the record has unpublished draft changes, including pending translation changes, that can be published.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountType`	AccountTypeEntity	Account type the form-level translation applies to.
`appointmentType`	AppointmentTypeEntity	Appointment type the form-level translation applies to.
`contactType`	ContactTypeEntity	Contact type the form-level translation applies to.
`data`	DataEntity	Data option (dropdown/radio choice) this row translates. Set when labelType is Data.
`field`	FieldEntity	Field whose name/label this row translates. Set when labelType is Field, FormField, or FormDescription.
`leadType`	LeadTypeEntity	Lead type the form-level translation applies to.
`opptyProductRelationType`	OpptyProductRelationTypeEntity	Opportunity product relation type the form-level translation applies to.
`opptyType`	OpportunityTypeEntity	Opportunity type the form-level translation applies to.
`productType`	ProductTypeEntity	Product type the form-level translation applies to.
`projectType`	ProjectTypeEntity	Project type the form-level translation applies to.
`taskType`	TaskTypeEntity	Task type the form-level translation applies to.
`accountTypeId`	ID	Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`appointmentTypeId`	ID	Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`contactTypeId`	ID	Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`dataId`	ID	Id of the translated data option.
`deDe`	String	Translated text in German.
`enUs`	String	Translated text in US English.
`esEs`	String	Translated text in Spanish.
`fieldId`	ID	Id of the translated field.
`formType`	FormTypeEnum	Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription.
`labelType`	TranslationLabelTypeEnum!	Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription).
`leadTypeId`	ID	Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`opptyProductRelationTypeId`	ID	Id of the opportunity product relation type.
`opptyTypeId`	ID	Id of the opportunity type.
`productTypeId`	ID	Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`projectTypeId`	ID	Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`ptBr`	String	Translated text in Brazilian Portuguese.
`taskTypeId`	ID	Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`isPublished`	Boolean	True when the translation is published; false while it exists only as an unpublished draft.
`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.

TranslationEntityConnection object pageInfo: PageInfo!, edges: [TranslationEntityEdge]!, totalCount: Int

Paginated list of Translation records.

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

TranslationEntityEdge object node: TranslationEntity, cursor: String!

A Relay edge containing a TranslationEntity and its cursor.

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

FormTypeEnumFilterInput input eq: [FormTypeEnum!], NOT: FormTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[FormTypeEnum!]	Matches any of the listed values.
`NOT`	FormTypeEnumFilterInput	Matches values that do not meet this condition.

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

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

Input field	Type	Description
`OR`	[TranslationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[TranslationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	TranslationFilterInput	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.
`accountTypeId`	EntityFilterStringField	Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`appointmentTypeId`	EntityFilterStringField	Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`contactTypeId`	EntityFilterStringField	Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`dataId`	EntityFilterStringField	Id of the translated data option.
`deDe`	EntityFilterStringField	Translated text in German.
`enUs`	EntityFilterStringField	Translated text in US English.
`esEs`	EntityFilterStringField	Translated text in Spanish.
`fieldId`	EntityFilterStringField	Id of the translated field.
`formType`	FormTypeEnumFilterInput	Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription.
`labelType`	TranslationLabelTypeEnumFilterInput	Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription).
`leadTypeId`	EntityFilterStringField	Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`opptyProductRelationTypeId`	EntityFilterStringField	Id of the opportunity product relation type.
`opptyTypeId`	EntityFilterStringField	Id of the opportunity type.
`productTypeId`	EntityFilterStringField	Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`projectTypeId`	EntityFilterStringField	Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`ptBr`	EntityFilterStringField	Translated text in Brazilian Portuguese.
`taskTypeId`	EntityFilterStringField	Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`isPublished`	Boolean	True when the translation is published; false while it exists only as an unpublished draft.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`accountType`	AccountTypeFilterInput	Account type the form-level translation applies to. Matches records where a related record meets these conditions.
`appointmentType`	AppointmentTypeFilterInput	Appointment type the form-level translation applies to. Matches records where a related record meets these conditions.
`contactType`	ContactTypeFilterInput	Contact type the form-level translation applies to. Matches records where a related record meets these conditions.
`data`	DataFilterInput	Data option (dropdown/radio choice) this row translates. Set when labelType is Data. Matches records where a related record meets these conditions.
`field`	FieldFilterInput	Field whose name/label this row translates. Set when labelType is Field, FormField, or FormDescription. Matches records where a related record meets these conditions.
`leadType`	LeadTypeFilterInput	Lead type the form-level translation applies to. Matches records where a related record meets these conditions.
`opptyProductRelationType`	OpptyProductRelationTypeFilterInput	Opportunity product relation type the form-level translation applies to. Matches records where a related record meets these conditions.
`opptyType`	OpportunityTypeFilterInput	Opportunity type the form-level translation applies to. Matches records where a related record meets these conditions.
`productType`	ProductTypeFilterInput	Product type the form-level translation applies to. Matches records where a related record meets these conditions.
`projectType`	ProjectTypeFilterInput	Project type the form-level translation applies to. Matches records where a related record meets these conditions.
`taskType`	TaskTypeFilterInput	Task type the form-level translation applies to. Matches records where a related record meets these conditions.

TranslationLabelTypeEnumFilterInput input eq: [TranslationLabelTypeEnum!], NOT: TranslationLabelTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[TranslationLabelTypeEnum!]	Matches any of the listed values.
`NOT`	TranslationLabelTypeEnumFilterInput	Matches values that do not meet this condition.

TranslationOrderByInput input Asc or Desc per field

Sorting of Translation 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.
`accountType`	[AccountTypeOrderByNestedInput!]	Account type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`appointmentType`	[AppointmentTypeOrderByNestedInput!]	Appointment type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`contactType`	[ContactTypeOrderByNestedInput!]	Contact type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`data`	[DataOrderByNestedInput!]	Data option (dropdown/radio choice) this row translates. Set when labelType is Data. Sorts by fields of the related record, listed in order of priority.
`field`	[FieldOrderByNestedInput!]	Field whose name/label this row translates. Set when labelType is Field, FormField, or FormDescription. Sorts by fields of the related record, listed in order of priority.
`leadType`	[LeadTypeOrderByNestedInput!]	Lead type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`opptyProductRelationType`	[OpptyProductRelationTypeOrderByNestedInput!]	Opportunity product relation type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`opptyType`	[OpportunityTypeOrderByNestedInput!]	Opportunity type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`productType`	[ProductTypeOrderByNestedInput!]	Product type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`projectType`	[ProjectTypeOrderByNestedInput!]	Project type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`taskType`	[TaskTypeOrderByNestedInput!]	Task type the form-level translation applies to. Sorts by fields of the related record, listed in order of priority.
`accountTypeId`	OrderByEnum	Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`appointmentTypeId`	OrderByEnum	Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`contactTypeId`	OrderByEnum	Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`dataId`	OrderByEnum	Id of the translated data option.
`deDe`	OrderByEnum	Translated text in German.
`enUs`	OrderByEnum	Translated text in US English.
`esEs`	OrderByEnum	Translated text in Spanish.
`fieldId`	OrderByEnum	Id of the translated field.
`formType`	OrderByEnum	Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription.
`labelType`	OrderByEnum	Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription).
`leadTypeId`	OrderByEnum	Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`opptyProductRelationTypeId`	OrderByEnum	Id of the opportunity product relation type.
`opptyTypeId`	OrderByEnum	Id of the opportunity type.
`productTypeId`	OrderByEnum	Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`projectTypeId`	OrderByEnum	Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`ptBr`	OrderByEnum	Translated text in Brazilian Portuguese.
`taskTypeId`	OrderByEnum	Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`isPublished`	OrderByEnum	True when the translation is published; false while it exists only as an unpublished draft.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateDraftTranslationInput input 21 fields: clientMutationId, modified, created, …

Parameters of the createTranslation mutation.

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.
`accountTypeId`	ID	Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`appointmentTypeId`	ID	Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`contactTypeId`	ID	Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`dataId`	ID	Id of the translated data option.
`deDe`	String	Translated text in German.
`enUs`	String	Translated text in US English.
`esEs`	String	Translated text in Spanish.
`fieldId`	ID	Id of the translated field.
`formType`	FormTypeEnum	Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription.
`labelType`	TranslationLabelTypeEnum!	Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription).
`leadTypeId`	ID	Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`opptyProductRelationTypeId`	ID	Id of the opportunity product relation type.
`opptyTypeId`	ID	Id of the opportunity type.
`productTypeId`	ID	Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`projectTypeId`	ID	Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`ptBr`	String	Translated text in Brazilian Portuguese.
`taskTypeId`	ID	Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`revision`	Int	Revision when entity was lastly changed.

DeleteDraftTranslationInput input clientMutationId: String, id: ID

Parameters of the deleteTranslation mutation.

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.

UpdateDraftTranslationInput input 23 fields: clientMutationId, id, isDeleted, …

Parameters of the updateTranslation mutation.

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.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountTypeId`	ID	Id of the account type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`appointmentTypeId`	ID	Id of the appointment type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`contactTypeId`	ID	Id of the contact type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`dataId`	ID	Id of the translated data option.
`deDe`	String	Translated text in German.
`enUs`	String	Translated text in US English.
`esEs`	String	Translated text in Spanish.
`fieldId`	ID	Id of the translated field.
`formType`	FormTypeEnum	Form of the record type the translation applies to: the edit form, or the lost form of a lead or opportunity type. Required when labelType is FormField or FormDescription.
`labelType`	TranslationLabelTypeEnum	Kind of text the row translates: a field name (Field), a dropdown or radio option (Data), or the label or description of a field on the form of one record type (FormField, FormDescription).
`leadTypeId`	ID	Id of the lead type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`opptyProductRelationTypeId`	ID	Id of the opportunity product relation type.
`opptyTypeId`	ID	Id of the opportunity type.
`productTypeId`	ID	Id of the product type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`projectTypeId`	ID	Id of the project type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`ptBr`	String	Translated text in Brazilian Portuguese.
`taskTypeId`	ID	Id of the task type whose form this translation applies to. Set only when labelType is FormField or FormDescription.
`revision`	Int	Revision when entity was lastly changed.

CreateTranslationPayload object translation: TranslationEntity, clientMutationId: String

Result of the createTranslation mutation.

Field	Type	Description
`translation`	TranslationEntity	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).

DeleteTranslationPayload object translation: TranslationEntity, clientMutationId: String

Result of the deleteTranslation mutation.

Field	Type	Description
`translation`	TranslationEntity	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).

UpdateTranslationPayload object translation: TranslationEntity!, clientMutationId: String

Result of the updateTranslation mutation.

Field	Type	Description
`translation`	TranslationEntity!	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).

FormTypeEnum enum Edit, Lost

Which form of a lead or opportunity type a setting applies to.

Value	Description
`Edit`	The record detail (edit) form.
`Lost`	The form shown when a lead or opportunity is marked as lost.

TranslationLabelTypeEnum enum Field, Data, FormField, FormDescription

Kind of text a translation entry translates.

Value	Description
`Field`	Name of a field.
`Data`	Option of a dropdown or radio field.
`FormField`	Label of a field on the form of a specific record type.
`FormDescription`	Description of a field on the form of a specific record type.