GraphQLRepositoriesleadOpptyContactRelation
entities.leadOpptyContactRelation
Read lead oppty contact relation records with the leadOpptyContactRelation repository, and change them with the lead oppty contact relation mutations. Same records as the REST LeadOpptyContactRelations entity.
Queries
Fields of entities { leadOpptyContactRelation { … } }.
| 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. | LeadOpptyContactRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [LeadOpptyContactRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: LeadOpptyContactRelationFilterInput, orderBy: [LeadOpptyContactRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [LeadOpptyContactRelationEntity!]! |
| QUERY | getByCriteria(filter: LeadOpptyContactRelationFilterInput, orderBy: [LeadOpptyContactRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | LeadOpptyContactRelationEntityConnection |
| 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 | createLeadOpptyContactRelation(input: CreateLeadOpptyContactRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateLeadOpptyContactRelationPayload |
| MUTATION | updateLeadOpptyContactRelation(input: UpdateLeadOpptyContactRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateLeadOpptyContactRelationPayload |
| MUTATION | bulkUpdateLeadOpptyContactRelation(input: [CreateOrUpdateLeadOpptyContactRelationInput!]!, deleteInput: [DeleteLeadOpptyContactRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateLeadOpptyContactRelationPayload |
| MUTATION | deleteLeadOpptyContactRelation(input: DeleteLeadOpptyContactRelationInput!) | Soft-delete | DeleteLeadOpptyContactRelationPayload |
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.
LeadOpptyContactRelationEntity object 19 fields: isDeleteProtected, id, isDeleted, …
Link between a lead or opportunity and a contact, with the contact's sales roles and org-chart position.
| 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. |
contact | ContactEntity | Contact linked to the lead or opportunity. |
leadOpptyContactGroupRelation | LeadOpptyContactGroupRelationEntity | Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. |
lead | LeadEntity | Lead the contact is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. |
oppty | OpportunityEntity | Opportunity the contact is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. |
comment | String | Free-form note describing this contact link. |
contactId | ID! | Id of the contact linked to the lead or opportunity. |
isPrimary | Boolean! | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
leadOpptyContactGroupRelationId | ID | Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. |
leadOpptyId | ID! | Id of the lead or opportunity this link belongs to. |
positionInGroup | JSONString | Org-chart layout position of the contact within its group, as a JSON object {"x": <int>, "y": <int>}. |
relationship | OrgRelationshipTypeEnum | Org-chart relationship of the contact within the lead/opportunity hierarchy. |
revision | Int | Revision when entity was lastly changed. |
salesRoles | [LeadOpptyContactSalesRoleRelationEntity!] | Sales roles assigned to the contact for this lead or opportunity. |
instancePermissions | [EntityPermsEnum!]! (1 args) | Permissions the current user has on this record, out of the requested ones. |
LeadOpptyContactRelationEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptyContactRelationEntityEdge]!, totalCount: Int
Paginated list of LeadOpptyContactRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [LeadOpptyContactRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
LeadOpptyContactRelationEntityEdge object node: LeadOpptyContactRelationEntity, cursor: String!
A Relay edge containing a LeadOpptyContactRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | LeadOpptyContactRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
LeadOpptyContactRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for LeadOpptyContactRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [LeadOpptyContactRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [LeadOpptyContactRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | LeadOpptyContactRelationFilterInput | 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. |
comment | EntityFilterStringField | Free-form note describing this contact link. |
contactId | EntityFilterStringField | Id of the contact linked to the lead or opportunity. |
isPrimary | Boolean | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
leadOpptyContactGroupRelationId | EntityFilterStringField | Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. |
leadOpptyId | EntityFilterStringField | Id of the lead or opportunity this link belongs to. |
relationship | OrgRelationshipTypeEnumFilterInput | Org-chart relationship of the contact within the lead/opportunity hierarchy. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
contact | ContactFilterInput | Contact linked to the lead or opportunity. Matches records where a related record meets these conditions. |
leadOpptyContactGroupRelation | LeadOpptyContactGroupRelationFilterInput | Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Matches records where a related record meets these conditions. |
lead | LeadFilterInput | Lead the contact is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions. |
oppty | OpportunityFilterInput | Opportunity the contact is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. |
salesRoles | LeadOpptyContactSalesRoleRelationFilterInput | Sales roles assigned to the contact for this lead or opportunity. Matches records where a related record meets these conditions. |
LeadOpptyContactRelationOrderByInput input Asc or Desc per field
Sorting of LeadOpptyContactRelation 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. |
contact | [ContactOrderByNestedInput!] | Contact linked to the lead or opportunity. Sorts by fields of the related record, listed in order of priority. |
leadOpptyContactGroupRelation | [LeadOpptyContactGroupRelationOrderByNestedInput!] | Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Sorts by fields of the related record, listed in order of priority. |
lead | [LeadOrderByNestedInput!] | Lead the contact is linked 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 the contact is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. |
comment | OrderByEnum | Free-form note describing this contact link. |
contactId | OrderByEnum | Id of the contact linked to the lead or opportunity. |
isPrimary | OrderByEnum | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
leadOpptyContactGroupRelationId | OrderByEnum | Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. |
leadOpptyId | OrderByEnum | Id of the lead or opportunity this link belongs to. |
relationship | OrderByEnum | Org-chart relationship of the contact within the lead/opportunity hierarchy. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateLeadOpptyContactRelationInput input 13 fields: clientMutationId, modified, created, …
Field values of a new LeadOpptyContactRelation 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. |
leadOpptyContactGroupRelation | CreateLeadOpptyContactGroupRelationInput | Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. |
comment | String | Free-form note describing this contact link. |
contactId | ID! | Id of the contact linked to the lead or opportunity. |
isPrimary | Boolean! | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
leadOpptyContactGroupRelationId | ID | Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. |
leadOpptyId | ID! | Id of the lead or opportunity this link belongs to. |
positionInGroup | JSONString | Org-chart layout position of the contact within its group, as a JSON object {"x": <int>, "y": <int>}. |
relationship | OrgRelationshipTypeEnum | Org-chart relationship of the contact within the lead/opportunity hierarchy. |
revision | Int | Revision when entity was lastly changed. |
salesRoles | [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] | Sales roles assigned to the contact for this lead or opportunity. |
CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput input modified: DateTime, created: DateTime, salesRoleId: ID!, revision: Int
Field values of a new LeadOpptyContactSalesRoleRelation record, created together with the record it belongs to.
| Input field | Type | Description |
|---|---|---|
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
salesRoleId | ID! | Id of the sales role assigned to the contact on this lead or opportunity. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateLeadOpptyContactRelationInput input 14 fields: clientMutationId, id, modified, …
Field values of a LeadOpptyContactRelation 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. |
leadOpptyContactGroupRelation | CreateLeadOpptyContactGroupRelationInput | Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. |
comment | String | Free-form note describing this contact link. |
contactId | ID | Id of the contact linked to the lead or opportunity. |
isPrimary | Boolean | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
leadOpptyContactGroupRelationId | ID | Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. |
leadOpptyId | ID | Id of the lead or opportunity this link belongs to. |
positionInGroup | JSONString | Org-chart layout position of the contact within its group, as a JSON object {"x": <int>, "y": <int>}. |
relationship | OrgRelationshipTypeEnum | Org-chart relationship of the contact within the lead/opportunity hierarchy. |
revision | Int | Revision when entity was lastly changed. |
salesRoles | [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] | Sales roles assigned to the contact for this lead or opportunity. |
DeleteLeadOpptyContactRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID
Id of the LeadOpptyContactRelation 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 this link belongs to. |
UpdateLeadOpptyContactRelationInput input 14 fields: clientMutationId, id, modified, …
Id of a LeadOpptyContactRelation 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. |
leadOpptyContactGroupRelation | CreateLeadOpptyContactGroupRelationInput | Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. |
comment | String | Free-form note describing this contact link. |
contactId | ID | Id of the contact linked to the lead or opportunity. |
isPrimary | Boolean | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
leadOpptyContactGroupRelationId | ID | Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity. |
leadOpptyId | ID | Id of the lead or opportunity this link belongs to. |
positionInGroup | JSONString | Org-chart layout position of the contact within its group, as a JSON object {"x": <int>, "y": <int>}. |
relationship | OrgRelationshipTypeEnum | Org-chart relationship of the contact within the lead/opportunity hierarchy. |
revision | Int | Revision when entity was lastly changed. |
salesRoles | [CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!] | Sales roles assigned to the contact for this lead or opportunity. |
BulkUpdateLeadOpptyContactRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateLeadOpptyContactRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateLeadOpptyContactRelationPayload object leadOpptyContactRelation: LeadOpptyContactRelationEntity, clientMutationId: String
Result of the createLeadOpptyContactRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptyContactRelation | LeadOpptyContactRelationEntity | 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). |
DeleteLeadOpptyContactRelationPayload object leadOpptyContactRelation: LeadOpptyContactRelationEntity, clientMutationId: String
Result of the deleteLeadOpptyContactRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptyContactRelation | LeadOpptyContactRelationEntity | 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). |
UpdateLeadOpptyContactRelationPayload object leadOpptyContactRelation: LeadOpptyContactRelationEntity, clientMutationId: String
Result of the updateLeadOpptyContactRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptyContactRelation | LeadOpptyContactRelationEntity | 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). |