GraphQL RepositoriesleadOppty

`entities.leadOppty`

Read lead oppty records with the leadOppty repository, and change them with the lead oppty mutations. Same records as the REST LeadOppties entity.

Example: first three lead oppty recordsGraphQLcURL

query FirstLeadOpptys {
  entities {
    leadOppty {
      getByCriteria(first: 3) {
        totalCount
        edges { node { id } }
      }
    }
  }
}

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 FirstLeadOpptys { entities { leadOppty { getByCriteria(first: 3) { totalCount edges { node { id } } } } } }"}'

Queries

Fields of entities { leadOppty { … } }.

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.	LeadOpptyEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadOpptyEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadOpptyFilterInput, orderBy: [LeadOpptyOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadOpptyEntity!]!
QUERY	`getByCriteria`(filter: LeadOpptyFilterInput, orderBy: [LeadOpptyOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadOpptyEntityConnection
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	`reactivateLeadOppty`(input: ReactivateLeadOpptyInput!)	Undo archive GraphQL only	ReactivateLeadOpptyPayload

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.

LeadOpptyEntity object 6 fields: customFields, pendingScheduledActions, isDeleteProtected, …

Lead or opportunity, with the fields both kinds of sales records share.

Field	Type	Description
`customFields`	JSONString! (1 args)	Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
`pendingScheduledActions`	Int	Filled only when a single record is read by its id; otherwise null or an empty list.
`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.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`fields`	[InterfaceFieldData]! (2 args)	Values of the fields shown in the record's preview pane, as configured for the record's type.

LeadOpptyEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptyEntityEdge]!, totalCount: Int

Paginated list of LeadOppty records.

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

LeadOpptyEntityEdge object node: LeadOpptyEntity, cursor: String!

A Relay edge containing a LeadOpptyEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[LeadOpptyFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[LeadOpptyFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	LeadOpptyFilterInput	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.
`relatedEntities`	[EntityFilterRelatedField]	Matches records related to at least one of the listed records.

LeadOpptyOrderByInput input Asc or Desc per field

Sorting of LeadOppty 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.
`relatedEntities`	CommonEntityRepositoryOrderByEntityRelationField	Sorts records by whether they are related to the listed records.

ReactivateLeadOpptyInput input id: UUID!, closingDate: Date, clientMutationId: String

Parameters of the reactivateLeadOppty mutation.

Input field	Type	Description
`id`	UUID!	Id of the archived lead or opportunity.
`closingDate`	Date	New expected closing date of a reactivated opportunity; when empty, the current closing date is kept. Not allowed for a lead.
`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).

ReactivateLeadOpptyPayload object result: LeadOpportunityEntity, clientMutationId: String

Result of the reactivateLeadOppty mutation.

Field	Type	Description
`result`	LeadOpportunityEntity	The reactivated lead or opportunity.
`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).

LeadOpportunityEntity union LeadEntity | OpportunityEntity

Either a lead or an opportunity.