GraphQL RepositoriesprofileRelation

`entities.profileRelation`

Read profile relation records with the profileRelation repository, and change them with the profile relation mutations. Same records as the REST ProfileRelations entity.

Example: first three profile relation recordsGraphQLcURL

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

Queries

Fields of entities { profileRelation { … } }.

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.	ProfileRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ProfileRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ProfileRelationFilterInput, orderBy: [ProfileRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ProfileRelationEntity!]!
QUERY	`getByCriteria`(filter: ProfileRelationFilterInput, orderBy: [ProfileRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ProfileRelationEntityConnection
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	`createProfileRelation`(input: CreateProfileRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateProfileRelationPayload
MUTATION	`updateProfileRelation`(input: UpdateProfileRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateProfileRelationPayload
MUTATION	`bulkUpdateProfileRelation`(input: [CreateOrUpdateProfileRelationInput!]!, deleteInput: [DeleteProfileRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateProfileRelationPayload
MUTATION	`deleteProfileRelation`(input: DeleteProfileRelationInput!)	Soft-delete	DeleteProfileRelationPayload

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.

ProfileRelationEntity object 21 fields: isDeleteProtected, id, isDeleted, …

Record added explicitly to a static saved view (profile).

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.
`account`	AccountEntity	Account this profile is linked to, when applicable.
`contact`	ContactEntity	Contact this profile is linked to, when applicable.
`customEntity`	CustomEntityEntity	Custom entity record this profile is linked to, when applicable.
`lead`	LeadEntity	Lead this profile is linked to. Set when leadOpptyId resolves to a Lead.
`oppty`	OpportunityEntity	Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity.
`profile`	ProfileEntity	Screen profile this relation links to a specific record.
`project`	ProjectEntity	Project this profile is linked to, when applicable.
`quote`	QuoteEntity	Quote this profile is linked to, when applicable.
`accountId`	ID	Id of the linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not pointing to one.
`profileId`	ID!	Id of the screen profile.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

ProfileRelationEntityConnection object pageInfo: PageInfo!, edges: [ProfileRelationEntityEdge]!, totalCount: Int

Paginated list of ProfileRelation records.

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

ProfileRelationEntityEdge object node: ProfileRelationEntity, cursor: String!

A Relay edge containing a ProfileRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ProfileRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ProfileRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ProfileRelationFilterInput	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.
`accountId`	EntityFilterStringField	Id of the linked account.
`contactId`	EntityFilterStringField	Id of the linked contact.
`customEntityId`	EntityFilterStringField	Id of the linked custom entity record.
`leadOpptyId`	EntityFilterStringField	Id of the linked lead or opportunity, or empty when not pointing to one.
`profileId`	EntityFilterStringField	Id of the screen profile.
`projectId`	EntityFilterStringField	Id of the linked project.
`quoteId`	EntityFilterStringField	Id of the linked quote.
`account`	AccountFilterInput	Account this profile is linked to, when applicable. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact this profile is linked to, when applicable. Matches records where a related record meets these conditions.
`customEntity`	CustomEntityFilterInput	Custom entity record this profile is linked to, when applicable. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions.
`profile`	ProfileFilterInput	Screen profile this relation links to a specific record. Matches records where a related record meets these conditions.
`project`	ProjectFilterInput	Project this profile is linked to, when applicable. Matches records where a related record meets these conditions.
`quote`	QuoteFilterInput	Quote this profile is linked to, when applicable. Matches records where a related record meets these conditions.

ProfileRelationOrderByInput input Asc or Desc per field

Sorting of ProfileRelation 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.
`account`	[AccountOrderByNestedInput!]	Account this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority.
`profile`	[ProfileOrderByNestedInput!]	Screen profile this relation links to a specific record. Sorts by fields of the related record, listed in order of priority.
`project`	[ProjectOrderByNestedInput!]	Project this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`quote`	[QuoteOrderByNestedInput!]	Quote this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the linked account.
`contactId`	OrderByEnum	Id of the linked contact.
`customEntityId`	OrderByEnum	Id of the linked custom entity record.
`leadOpptyId`	OrderByEnum	Id of the linked lead or opportunity, or empty when not pointing to one.
`profileId`	OrderByEnum	Id of the screen profile.
`projectId`	OrderByEnum	Id of the linked project.
`quoteId`	OrderByEnum	Id of the linked quote.

CreateOrUpdateProfileRelationInput input 11 fields: clientMutationId, id, modified, …

Field values of a ProfileRelation 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.
`accountId`	ID	Id of the linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not pointing to one.
`profileId`	ID	Id of the screen profile.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.

CreateProfileRelationInput input 10 fields: clientMutationId, modified, created, …

Field values of a new ProfileRelation 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.
`accountId`	ID	Id of the linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not pointing to one.
`profileId`	ID!	Id of the screen profile.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.

DeleteProfileRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID

Id of the ProfileRelation 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.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not pointing to one.

UpdateProfileRelationInput input 11 fields: clientMutationId, id, modified, …

Id of a ProfileRelation 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.
`accountId`	ID	Id of the linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not pointing to one.
`profileId`	ID	Id of the screen profile.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.

BulkUpdateProfileRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateProfileRelation mutation.

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

CreateProfileRelationPayload object profileRelation: ProfileRelationEntity, clientMutationId: String

Result of the createProfileRelation mutation.

Field	Type	Description
`profileRelation`	ProfileRelationEntity	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).

DeleteProfileRelationPayload object profileRelation: ProfileRelationEntity, clientMutationId: String

Result of the deleteProfileRelation mutation.

Field	Type	Description
`profileRelation`	ProfileRelationEntity	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).

UpdateProfileRelationPayload object profileRelation: ProfileRelationEntity, clientMutationId: String

Result of the updateProfileRelation mutation.

Field	Type	Description
`profileRelation`	ProfileRelationEntity	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).