GraphQLRepositoriesleadOpptyAccountRelation
entities.leadOpptyAccountRelation
Read lead oppty account relation records with the leadOpptyAccountRelation repository, and change them with the lead oppty account relation mutations. Same records as the REST LeadOpptyAccountRelations entity.
Queries
Fields of entities { leadOpptyAccountRelation { … } }.
| 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. | LeadOpptyAccountRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [LeadOpptyAccountRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: LeadOpptyAccountRelationFilterInput, orderBy: [LeadOpptyAccountRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [LeadOpptyAccountRelationEntity!]! |
| QUERY | getByCriteria(filter: LeadOpptyAccountRelationFilterInput, orderBy: [LeadOpptyAccountRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | LeadOpptyAccountRelationEntityConnection |
| 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 | createLeadOpptyAccountRelation(input: CreateLeadOpptyAccountRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateLeadOpptyAccountRelationPayload |
| MUTATION | updateLeadOpptyAccountRelation(input: UpdateLeadOpptyAccountRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateLeadOpptyAccountRelationPayload |
| MUTATION | bulkUpdateLeadOpptyAccountRelation(input: [CreateOrUpdateLeadOpptyAccountRelationInput!]!, deleteInput: [DeleteLeadOpptyAccountRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateLeadOpptyAccountRelationPayload |
| MUTATION | deleteLeadOpptyAccountRelation(input: DeleteLeadOpptyAccountRelationInput!) | Soft-delete | DeleteLeadOpptyAccountRelationPayload |
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.
LeadOpptyAccountRelationEntity object 13 fields: isDeleteProtected, id, isDeleted, …
Link between a lead or opportunity and an account, marking the primary account.
| 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 linked to the lead or opportunity. |
lead | LeadEntity | Lead the account is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. |
oppty | OpportunityEntity | Opportunity the account is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. |
accountId | ID! | Id of the account 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. |
leadOpptyId | ID! | Id of the lead or opportunity this link belongs to. |
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. |
LeadOpptyAccountRelationEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptyAccountRelationEntityEdge]!, totalCount: Int
Paginated list of LeadOpptyAccountRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [LeadOpptyAccountRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
LeadOpptyAccountRelationEntityEdge object node: LeadOpptyAccountRelationEntity, cursor: String!
A Relay edge containing a LeadOpptyAccountRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | LeadOpptyAccountRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
LeadOpptyAccountRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for LeadOpptyAccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [LeadOpptyAccountRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [LeadOpptyAccountRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | LeadOpptyAccountRelationFilterInput | 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 account 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. |
leadOpptyId | EntityFilterStringField | Id of the lead or opportunity this link belongs to. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
account | AccountFilterInput | Account linked to the lead or opportunity. Matches records where a related record meets these conditions. |
lead | LeadFilterInput | Lead the account 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 account is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions. |
LeadOpptyAccountRelationOrderByInput input Asc or Desc per field
Sorting of LeadOpptyAccountRelation 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 linked to the lead or opportunity. Sorts by fields of the related record, listed in order of priority. |
lead | [LeadOrderByNestedInput!] | Lead the account 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 account is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority. |
accountId | OrderByEnum | Id of the account 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. |
leadOpptyId | OrderByEnum | Id of the lead or opportunity this link belongs to. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateLeadOpptyAccountRelationInput input 7 fields: clientMutationId, modified, created, …
Field values of a new LeadOpptyAccountRelation 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 account 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. |
leadOpptyId | ID! | Id of the lead or opportunity this link belongs to. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateLeadOpptyAccountRelationInput input 8 fields: clientMutationId, id, modified, …
Field values of a LeadOpptyAccountRelation 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 account 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. |
leadOpptyId | ID | Id of the lead or opportunity this link belongs to. |
revision | Int | Revision when entity was lastly changed. |
DeleteLeadOpptyAccountRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID
Id of the LeadOpptyAccountRelation 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. |
UpdateLeadOpptyAccountRelationInput input 8 fields: clientMutationId, id, modified, …
Id of a LeadOpptyAccountRelation 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 account 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. |
leadOpptyId | ID | Id of the lead or opportunity this link belongs to. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateLeadOpptyAccountRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateLeadOpptyAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateLeadOpptyAccountRelationPayload object leadOpptyAccountRelation: LeadOpptyAccountRelationEntity, clientMutationId: String
Result of the createLeadOpptyAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptyAccountRelation | LeadOpptyAccountRelationEntity | 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). |
DeleteLeadOpptyAccountRelationPayload object leadOpptyAccountRelation: LeadOpptyAccountRelationEntity, clientMutationId: String
Result of the deleteLeadOpptyAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptyAccountRelation | LeadOpptyAccountRelationEntity | 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). |
UpdateLeadOpptyAccountRelationPayload object leadOpptyAccountRelation: LeadOpptyAccountRelationEntity, clientMutationId: String
Result of the updateLeadOpptyAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
leadOpptyAccountRelation | LeadOpptyAccountRelationEntity | 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). |