GraphQL RepositoriesleadOpptyContactGroupRelation

`entities.leadOpptyContactGroupRelation`

Read lead oppty contact group relation records with the leadOpptyContactGroupRelation repository, and change them with the lead oppty contact group relation mutations. Same records as the REST LeadOpptyContactGroupRelations entity.

Example: first three lead oppty contact group relation recordsGraphQLcURL

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

Queries

Fields of entities { leadOpptyContactGroupRelation { … } }.

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.	LeadOpptyContactGroupRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadOpptyContactGroupRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadOpptyContactGroupRelationFilterInput, orderBy: [LeadOpptyContactGroupRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadOpptyContactGroupRelationEntity!]!
QUERY	`getByCriteria`(filter: LeadOpptyContactGroupRelationFilterInput, orderBy: [LeadOpptyContactGroupRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadOpptyContactGroupRelationEntityConnection
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	`createLeadOpptyContactGroupRelation`(input: CreateLeadOpptyContactGroupRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateLeadOpptyContactGroupRelationPayload
MUTATION	`updateLeadOpptyContactGroupRelation`(input: UpdateLeadOpptyContactGroupRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateLeadOpptyContactGroupRelationPayload
MUTATION	`bulkUpdateLeadOpptyContactGroupRelation`(input: [CreateOrUpdateLeadOpptyContactGroupRelationInput!]!, deleteInput: [DeleteLeadOpptyContactGroupRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateLeadOpptyContactGroupRelationPayload
MUTATION	`deleteLeadOpptyContactGroupRelation`(input: DeleteLeadOpptyContactGroupRelationInput!)	Soft-delete	DeleteLeadOpptyContactGroupRelationPayload

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.

LeadOpptyContactGroupRelationEntity object 13 fields: isDeleteProtected, id, isDeleted, …

Group of contacts on the org chart of a lead or opportunity.

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.
`lead`	LeadEntity	Lead this contact group belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty.
`oppty`	OpportunityEntity	Opportunity this contact group belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty.
`color`	Int!	Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`groupPosition`	JSONString!	Org-chart layout of the contact group, as a JSON object {"x": <int>, "y": <int>, "width": <int>, "height": <int>}.
`leadOpptyId`	ID!	Id of the lead or opportunity the contact group belongs to.
`name`	String!	Name of the entity and its default text representation.
`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.

LeadOpptyContactGroupRelationEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptyContactGroupRelationEntityEdge]!, totalCount: Int

Paginated list of LeadOpptyContactGroupRelation records.

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

LeadOpptyContactGroupRelationEntityEdge object node: LeadOpptyContactGroupRelationEntity, cursor: String!

A Relay edge containing a LeadOpptyContactGroupRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[LeadOpptyContactGroupRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[LeadOpptyContactGroupRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	LeadOpptyContactGroupRelationFilterInput	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.
`color`	EntityFilterNumberField	Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`leadOpptyId`	EntityFilterStringField	Id of the lead or opportunity the contact group belongs to.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`lead`	LeadFilterInput	Lead this contact group belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity this contact group belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions.

LeadOpptyContactGroupRelationOrderByInput input Asc or Desc per field

Sorting of LeadOpptyContactGroupRelation 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.
`lead`	[LeadOrderByNestedInput!]	Lead this contact group belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity this contact group belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`color`	OrderByEnum	Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`leadOpptyId`	OrderByEnum	Id of the lead or opportunity the contact group belongs to.
`name`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateLeadOpptyContactGroupRelationInput input 8 fields: clientMutationId, modified, created, …

Field values of a new LeadOpptyContactGroupRelation 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.
`color`	Int!	Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`groupPosition`	JSONString!	Org-chart layout of the contact group, as a JSON object {"x": <int>, "y": <int>, "width": <int>, "height": <int>}.
`leadOpptyId`	ID!	Id of the lead or opportunity the contact group belongs to.
`name`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateLeadOpptyContactGroupRelationInput input 9 fields: clientMutationId, id, modified, …

Field values of a LeadOpptyContactGroupRelation 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.
`color`	Int	Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`groupPosition`	JSONString	Org-chart layout of the contact group, as a JSON object {"x": <int>, "y": <int>, "width": <int>, "height": <int>}.
`leadOpptyId`	ID	Id of the lead or opportunity the contact group belongs to.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

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

Id of the LeadOpptyContactGroupRelation 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 lead or opportunity the contact group belongs to.

UpdateLeadOpptyContactGroupRelationInput input 9 fields: clientMutationId, id, modified, …

Id of a LeadOpptyContactGroupRelation 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.
`color`	Int	Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`groupPosition`	JSONString	Org-chart layout of the contact group, as a JSON object {"x": <int>, "y": <int>, "width": <int>, "height": <int>}.
`leadOpptyId`	ID	Id of the lead or opportunity the contact group belongs to.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateLeadOpptyContactGroupRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateLeadOpptyContactGroupRelation mutation.

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

CreateLeadOpptyContactGroupRelationPayload object leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity, clientMutationId: String

Result of the createLeadOpptyContactGroupRelation mutation.

Field	Type	Description
`leadOpptyContactGroupRelation`	LeadOpptyContactGroupRelationEntity	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).

DeleteLeadOpptyContactGroupRelationPayload object leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity, clientMutationId: String

Result of the deleteLeadOpptyContactGroupRelation mutation.

Field	Type	Description
`leadOpptyContactGroupRelation`	LeadOpptyContactGroupRelationEntity	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).

UpdateLeadOpptyContactGroupRelationPayload object leadOpptyContactGroupRelation: LeadOpptyContactGroupRelationEntity, clientMutationId: String

Result of the updateLeadOpptyContactGroupRelation mutation.

Field	Type	Description
`leadOpptyContactGroupRelation`	LeadOpptyContactGroupRelationEntity	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).