Schema Types
Query
Mutation
Objects
AdditionalActionsResults
| Field |
Argument |
Type |
Description |
| createPublicShare |
JobShare |
|
Choice
| Field |
Argument |
Type |
Description |
| options |
[String!]! |
|
| chosen |
[String!] |
|
CreateJobResult
DateEntry
DeepLink
| Field |
Argument |
Type |
Description |
| url |
String! |
|
DeepLinks
DeleteJobResult
| Field |
Argument |
Type |
Description |
| id |
ID! |
|
DerivedData
| Field |
Argument |
Type |
Description |
| make |
String |
|
| model |
String |
|
| serial |
String |
|
| transcript |
String |
|
| manufacture_date |
AWSDateTime |
The manufacture date derived from the data plate, when we can do so.
|
DocumentationConnection
DocumentationItem
GetJobIdsResult
| Field |
Argument |
Type |
Description |
| jobIds |
[ID!]! |
|
GetJobResult
| Field |
Argument |
Type |
Description |
| job |
Job! |
|
GetJobSummaryResult
IntegrationEntityId
| Field |
Argument |
Type |
Description |
| namespace |
String! |
|
| id |
ID! |
|
Job
| Field |
Argument |
Type |
Description |
| id |
ID! |
The unique ID generated within XOi Cloud.
|
| integrationEntityId |
IntegrationEntityId |
The namespaced ID submitted by the integration that created the job
|
| createdAt |
AWSDateTime |
|
| createdBy |
ID |
|
| updatedAt |
AWSDateTime |
|
| completedAt |
AWSDateTime |
|
| completedBy |
ID |
|
| customerName |
String |
|
| customerEmail |
AWSEmail |
|
| internalNotificationContacts |
[InternalNotificationContact!] |
|
| jobLocation |
String |
|
| workOrderNumber |
String |
|
| assigneeIds |
[ID!]! |
This takes a list of Vision User IDs, but is currently enforced as a single item list. We plan to soon have the ability to have multiple Assignees per Job, so we are ensuring we do not need to change the API when that time comes.
|
| internalNote |
Note |
An optional Note added by a Vision User. You may note that this Note is a Note object and not directly a note string.
|
| label |
String |
The intent of this optional field is to provide a human-friendly label for each Job. It would be best to keep this unique, but we will not enforce that within XOi Cloud. This label will be displayed on the share page.
|
| tags |
[String!] |
|
| tagSuggestions |
[String!] |
Possible values to be suggested by the mobile app when entering tags
|
| deepLinks |
DeepLinks |
|
| workTypeIds |
[ID!] |
|
JobConnection
| Field |
Argument |
Type |
Description |
| items |
[Job!]! |
|
| nextToken |
String |
If this is present and a non-empty string, then there are more results to return. Use that value in a subsequent request to get those additional results. If the nextToken you receive from a query is an empty string then you know you have reached the end of the available items.
|
JobShare
| Field |
Argument |
Type |
Description |
| id |
ID! |
|
| shareLink |
String! |
|
JobSummary
ListDocumentationItem
ListDocumentationResult
ListJobsResult
ListWebhookHistoryResult
Note
| Field |
Argument |
Type |
Description |
| text |
String! |
If a note is present, it must contain text. That text can be no longer than 3000 characters.
|
NumberEntry
SupportRequestAgentInfo
| Field |
Argument |
Type |
Description |
| email |
String! |
|
TextEntry
| Field |
Argument |
Type |
Description |
| value |
String |
|
UpdateJobResult
| Field |
Argument |
Type |
Description |
| job |
Job! |
|
User
| Field |
Argument |
Type |
Description |
| id |
ID! |
The Vision User ID currently matches the User's email address, but do not rely on that to always be the case. If a User's email address changes after creation, the User ID will not change to match it. In a future release, we will be switching to GUIDs.
|
| email |
AWSEmail! |
|
| given_name |
String! |
|
| family_name |
String! |
|
| phone_number |
String! |
|
VisionMobileDeepLinks
| Field |
Argument |
Type |
Description |
| viewJob |
DeepLink |
This link is currently only present for a completed job
|
| editJob |
DeepLink |
|
| jobLocationActivitySearch |
DeepLink |
The requested job will only appear in location search once it is complete. Past completed jobs will still show up.
|
VisionWebDeepLinks
| Field |
Argument |
Type |
Description |
| viewJob |
DeepLink |
This link is currently only present for a completed job
|
WebhookHistoryConnection
| Field |
Argument |
Type |
Description |
| items |
[WebhookHistoryRecord!]! |
|
| nextToken |
String |
If this is present and a non-empty string, then there are more results to return. Use that value in a subsequent request to get those additional results. If the nextToken you receive from a query is an empty string then you know you have reached the end of the available items.
|
WebhookHistoryRecord
WorkSummary
| Field |
Argument |
Type |
Description |
| summary_text |
String! |
|
WorkflowSupportStatus
| Field |
Type |
Description |
| enabled |
Boolean! |
|
This allows you to filter your results by the chosen date type,
and return them in either ascending or descending order by that date.
| Field |
Type |
Description |
| id |
ID! |
|
| Field |
Type |
Description |
| workOrderNumber |
String |
NOTE: Work Order searches are case sensitive
|
| jobLocation |
String |
NOTE: Job Location searches are limited to single word searches at this time. If multiple words are used, no results will be returned.
|
| customerName |
String |
NOTE: Customer Name searches are limited to single word searches at this time. If multiple words are used, no results will be returned.
|
| Field |
Type |
Description |
| id |
ID! |
|
| Field |
Type |
Description |
| jobId |
ID! |
|
| workflowJobId |
ID |
If included, will filter to just documentation/steps associated with a specific workflow job
|
| nextToken |
String |
|
| includeAllSteps |
Boolean |
If true, will return all steps including those that have no documentation or specific step type response
|
These two parts of the composite ID must be universally unique
| Field |
Type |
Description |
| namespace |
String! |
Must be 10 or more characters - should be unique to your integration and must be a single, eternal, shared value across your entire integration.
|
| id |
ID! |
Your actual ID within your system. Must be unique within the universe of IDs that share the above namespace.
|
| Field |
Type |
Description |
| dateQuery |
DateQueryInput |
|
| nextToken |
String |
Set to an empty string to get the first subset of items. If you are trying to get the next set of items then you should give the nextToken you received from the last request for this input to get the next set of results.
|
| filter |
FilterInput |
|
| includeAllSteps |
Boolean |
If true, will return all steps including those that have no documentation or specific step type response
|
| Field |
Type |
Description |
| dateQuery |
DateQueryInput |
|
| limit |
Int! |
Set to the maximum number of items that you would like to be returned.
|
| nextToken |
String |
Set to an empty string to get the first subset of items. If you are trying to get the next set of items then you should give the nextToken you received from the last request for this input to get the next set of results.
|
| filter |
FilterInput |
|
| excludeJobIds |
[String!] |
If included, jobs with the supplied IDs will be excluded from the results. Only available if multiple workflows per job is enabled for the api user account. Contact us for details.
|
ListWebhookHistoryInput
| Field |
Type |
Description |
| integrationEntityId |
IntegrationEntityIdInput |
You can provide a namespaced id to look up this job with getJobIdsByIntegrationEntityId.
|
| assigneeIds |
[ID!]! |
This is an array so that we can allow multiple assignees in the future. Currently only one assignee is supported.
|
| customerName |
String! |
|
| customerEmail |
AWSEmail |
When a customer approval workflow on this job is completed, an approval request will be sent to this email.
|
| internalNotificationContacts |
[InternalNotificationContactInput!] |
Contacts specified here will receive notifications with links to "entire" job shares
containing internal data. Be careful to not include external emails, like
customer emails, if you don't want them to receive all job data.
|
| jobLocation |
String! |
|
| workOrderNumber |
String! |
|
| label |
String |
The intent of this optional field is to provide a human-friendly label for each Job. It would be best to keep this unique, but we will not enforce that within XOi Cloud. This label will be displayed on the share page.
|
| tags |
[String!] |
Anything you pass in as a `tag` here will then be searchable via the existing tag-based search capabilities.
|
| tagSuggestions |
[String!] |
Possible values to be suggested by the mobile app when entering tags
|
| internalNote |
NoteInput |
|
| workTypeIds |
[ID!] |
|
| Field |
Type |
Description |
| text |
String! |
If a note is present, it must contain text. That text can be no longer than 3000 characters.
|
| Field |
Type |
Description |
| assigneeIds |
[ID!] |
This is an array so that we can allow multiple assignees in the future. Currently only one assignee is supported.
|
| customerName |
String |
If provided, this field must be a non-empty string.
|
| customerEmail |
AWSEmail |
If provided, this field must be a non-empty string.
|
| jobLocation |
String |
If provided, this field must be a non-empty string.
|
| workOrderNumber |
String |
If provided, this field must be a non-empty string.
|
| internalNotificationContacts |
[InternalNotificationContactInput!] |
Contacts specified here will receive notifications with links to "entire" job shares
containing internal data. Be careful to not include external emails, like
customer emails, if you don't want them to receive all job data.
|
| label |
String |
|
| tags |
[String!] |
|
| tagSuggestions |
[String!] |
|
| internalNote |
NoteInput |
|
WebhookHistoryDateQueryInput
Enums
DocumentationItemTrait
| Value |
Description |
| dataplate |
|
| transcript |
|
| processed |
|
| pending |
|
| preliminary |
|
| not_a_dataplate |
|
| partial_dataplate |
|
| note |
|
| choice |
|
| number_entry |
|
| text_entry |
|
| date_entry |
|
| work_summary |
|
| ai_generated |
|
| user_edited |
|
| user_generated |
|
JobNotificationEventType
When setting internal notification contacts on a job, these are the events you
can choose for them to be notified of.
| Value |
Description |
| WORKFLOW_CUSTOMER_APPROVAL_SUBMISSION |
|
SortDateType
When submitting a dateQuery in a listJobs request, these are your options for sorting the returned jobs.
| Value |
Description |
| CREATED_AT |
|
| COMPLETED_AT |
|
Scalars
AWSDateTime
The AWSDateTime scalar type provided by AWS AppSync, represents a valid extended ISO 8601 DateTime string. In other words, this scalar type accepts datetime strings of the form YYYY-MM-DDThh:mm:ss.SSSZ. The scalar can also accept "negative years" of the form -YYYY which correspond to years before 0000. For example, "-2017-01-01T00:00Z" and "-9999-01-01T00:00Z" are both valid datetime strings. The field after the two digit seconds field is a nanoseconds field. It can accept between 1 and 9 digits. So, for example, "1970-01-01T12:00:00.2Z", "1970-01-01T12:00:00.277Z" and "1970-01-01T12:00:00.123456789Z" are all valid datetime strings. The seconds and nanoseconds fields are optional (the seconds field must be specified if the nanoseconds field is to be used). The time zone offset is compulsory for this scalar. The time zone offset must either be Z (representing the UTC time zone) or be in the format ±hh:mm:ss. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.
AWSEmail
The AWSEmail scalar type provided by AWS AppSync, represents an Email address string that complies with RFC 822. For example, "username@example.com" is a valid Email address.
Boolean
Built-in Boolean
Float
Built-in Float
ID
Built-in ID
Int
Built-in Int
String
Built-in String