SDA GraphQL Jobs API Reference

🚀 Welcome to the SDA GraphQL Jobs API

The SDA GraphQL Jobs API Reference contains the Queries, Mutations and Types you can use to interact with the SDA JOBS API to manage pipelines and jobs like backup, conversion and more...

⚠️ This website only contains the Schema reference. For examples and more information, please visit the SDA GraphQL API Examples repository.

Contact

Software Defined Automation

support@softwaredefinedautomation.io

https://www.softwaredefinedautomation.io

License

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0.html

Terms of Service

https://www.softwaredefinedautomation.io/terms-and-conditions/

API Endpoints
# Jobs GraphQL API:
https://api.sdaconsole.io/jobs/v1/graphql
Headers
# The token you received from the SDA Console or the API
Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

health

Description

Health check endpoint

Response

Returns a HealthResponseType!

Example

Query
query Health {
  health {
    status
    message
  }
}
Response
{
  "data": {
    "health": {
      "status": "abc123",
      "message": "xyz789"
    }
  }
}
Queries

projectConversionArtifacts

Description

Get project conversion artifacts

Response

Returns an ArtifactsResponseType!

Arguments
Name Description
projectId - String!
projectVersionId - String!

Example

Query
query ProjectConversionArtifacts(
  $projectId: String!,
  $projectVersionId: String!
) {
  projectConversionArtifacts(
    projectId: $projectId,
    projectVersionId: $projectVersionId
  ) {
    presignedUrl
    status
    message
  }
}
Variables
{
  "projectId": "xyz789",
  "projectVersionId": "xyz789"
}
Response
{
  "data": {
    "projectConversionArtifacts": {
      "presignedUrl": "xyz789",
      "status": "READY",
      "message": "xyz789"
    }
  }
}
Queries

readAllJobs

Description

Get all jobs

Response

Returns a PaginatedJobResponseType!

Arguments
Name Description
filter - JobFilterInput Default = null
pagination - PaginationInput Default = null

Example

Query
query ReadAllJobs(
  $filter: JobFilterInput,
  $pagination: PaginationInput
) {
  readAllJobs(
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      jobId
      jobType
      vendorId
      ideConfigId
      pipelineConfigurationId
      pipelineExecutionId
      deviceIds
      projectIds
      projectVersionIds
      licenseIds
      status
      duration
      timeOut
      errorMessage
      startTimestamp
      finishedTimestamp
      featureOptions
      logStream
      logGroup
      metaData
      companyName
      meteringReservationId
      source
      objectVersion
      creationUserId
      updateUserId
      creationTimestamp
      updateTimestamp
      groupId
      creationUser {
        ...UserResponseTypeFragment
      }
      updateUser {
        ...UserResponseTypeFragment
      }
      artifactsAvailable
    }
    itemCount
  }
}
Variables
{"filter": null, "pagination": null}
Response
{
  "data": {
    "readAllJobs": {
      "pages": 987,
      "items": [JobResponseType],
      "itemCount": 123
    }
  }
}
Queries

readAllJobsForPipelineExecution

Description

Get all jobs for a pipeline execution

Response

Returns a PaginatedJobResponseType!

Arguments
Name Description
pipelineExecutionId - String!
filter - JobFilterInput Default = null
pagination - PaginationInput Default = null

Example

Query
query ReadAllJobsForPipelineExecution(
  $pipelineExecutionId: String!,
  $filter: JobFilterInput,
  $pagination: PaginationInput
) {
  readAllJobsForPipelineExecution(
    pipelineExecutionId: $pipelineExecutionId,
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      jobId
      jobType
      vendorId
      ideConfigId
      pipelineConfigurationId
      pipelineExecutionId
      deviceIds
      projectIds
      projectVersionIds
      licenseIds
      status
      duration
      timeOut
      errorMessage
      startTimestamp
      finishedTimestamp
      featureOptions
      logStream
      logGroup
      metaData
      companyName
      meteringReservationId
      source
      objectVersion
      creationUserId
      updateUserId
      creationTimestamp
      updateTimestamp
      groupId
      creationUser {
        ...UserResponseTypeFragment
      }
      updateUser {
        ...UserResponseTypeFragment
      }
      artifactsAvailable
    }
    itemCount
  }
}
Variables
{
  "pipelineExecutionId": "xyz789",
  "filter": null,
  "pagination": null
}
Response
{
  "data": {
    "readAllJobsForPipelineExecution": {
      "pages": 123,
      "items": [JobResponseType],
      "itemCount": 123
    }
  }
}
Queries

readAllPipelineConfigurations

Description

Get all pipeline configurations

Response

Returns a PaginatedPipelineConfigurationResponseType!

Arguments
Name Description
filter - PipelineConfigurationFilterInput Default = null
pagination - PaginationInput Default = null

Example

Query
query ReadAllPipelineConfigurations(
  $filter: PipelineConfigurationFilterInput,
  $pagination: PaginationInput
) {
  readAllPipelineConfigurations(
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      nameLower
      pipelineConfigurationId
      groupId
      name
      description
      enabled
      trigger {
        ... on PipelineManualTriggerConfigurationType {
          ...PipelineManualTriggerConfigurationTypeFragment
        }
        ... on PipelineScheduledTriggerConfigurationType {
          ...PipelineScheduledTriggerConfigurationTypeFragment
        }
      }
      steps {
        ...PipelineStepConfigurationTypeFragment
      }
      deviceIds
      projectIds
      licenseIds
      projectVersionIds
      objectVersion
      creationUserId
      updateUserId
      creationTimestamp
      updateTimestamp
      creationUser {
        ...UserResponseTypeFragment
      }
      updateUser {
        ...UserResponseTypeFragment
      }
    }
    itemCount
  }
}
Variables
{"filter": null, "pagination": null}
Response
{
  "data": {
    "readAllPipelineConfigurations": {
      "pages": 123,
      "items": [PipelineConfigurationResponseType],
      "itemCount": 987
    }
  }
}
Queries

readAllPipelineExecutionsForConfiguration

Description

Get all pipeline executions for a configuration

Response

Returns a PaginatedPipelineExecutionResponseType!

Arguments
Name Description
pipelineConfigurationId - String!
filter - PipelineExecutionFilterInput Default = null
pagination - PaginationInput Default = null

Example

Query
query ReadAllPipelineExecutionsForConfiguration(
  $pipelineConfigurationId: String!,
  $filter: PipelineExecutionFilterInput,
  $pagination: PaginationInput
) {
  readAllPipelineExecutionsForConfiguration(
    pipelineConfigurationId: $pipelineConfigurationId,
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      creationUserId
      updateUserId
      groupId
      creationUser {
        ...UserResponseTypeFragment
      }
      updateUser {
        ...UserResponseTypeFragment
      }
      pipelineExecutionId
      pipelineConfigurationId
      name
      triggerSource {
        ... on PipelineManualTriggerConfigurationType {
          ...PipelineManualTriggerConfigurationTypeFragment
        }
        ... on PipelineScheduledTriggerConfigurationType {
          ...PipelineScheduledTriggerConfigurationTypeFragment
        }
      }
      status
      duration
      steps {
        ...PipelineExecutionStepResponseTypeFragment
      }
      objectVersion
      creationTimestamp
      updateTimestamp
    }
    itemCount
  }
}
Variables
{
  "pipelineConfigurationId": "xyz789",
  "filter": null,
  "pagination": null
}
Response
{
  "data": {
    "readAllPipelineExecutionsForConfiguration": {
      "pages": 123,
      "items": [PipelineExecutionResponseType],
      "itemCount": 123
    }
  }
}
Queries

readJob

Description

Get a job by ID

Response

Returns a JobResponseType!

Arguments
Name Description
jobId - String!

Example

Query
query ReadJob($jobId: String!) {
  readJob(jobId: $jobId) {
    jobId
    jobType
    vendorId
    ideConfigId
    pipelineConfigurationId
    pipelineExecutionId
    deviceIds
    projectIds
    projectVersionIds
    licenseIds
    status
    duration
    timeOut
    errorMessage
    startTimestamp
    finishedTimestamp
    featureOptions
    logStream
    logGroup
    metaData
    companyName
    meteringReservationId
    source
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    artifactsAvailable
  }
}
Variables
{"jobId": "abc123"}
Response
{
  "data": {
    "readJob": {
      "jobId": "xyz789",
      "jobType": "PROJECT_VIEW",
      "vendorId": "xyz789",
      "ideConfigId": "abc123",
      "pipelineConfigurationId": "abc123",
      "pipelineExecutionId": "abc123",
      "deviceIds": ["abc123"],
      "projectIds": ["xyz789"],
      "projectVersionIds": ["abc123"],
      "licenseIds": ["xyz789"],
      "status": "SUCCESS",
      "duration": 123,
      "timeOut": 987,
      "errorMessage": "xyz789",
      "startTimestamp": "2007-12-03T10:15:30Z",
      "finishedTimestamp": "2007-12-03T10:15:30Z",
      "featureOptions": {},
      "logStream": "abc123",
      "logGroup": "xyz789",
      "metaData": {},
      "companyName": "abc123",
      "meteringReservationId": "abc123",
      "source": "PIPELINE",
      "objectVersion": 987,
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "groupId": "abc123",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "artifactsAvailable": false
    }
  }
}
Queries

readJobLogs

Description

Get job logs

Response

Returns a JobLogsResponseType!

Arguments
Name Description
jobId - String!
filter - JobLogsFilterInput Default = null

Example

Query
query ReadJobLogs(
  $jobId: String!,
  $filter: JobLogsFilterInput
) {
  readJobLogs(
    jobId: $jobId,
    filter: $filter
  ) {
    logs {
      timestamp
      message
    }
    nextToken
  }
}
Variables
{"jobId": "abc123", "filter": null}
Response
{
  "data": {
    "readJobLogs": {
      "logs": [JobLogType],
      "nextToken": "xyz789"
    }
  }
}
Queries

readPipelineConfiguration

Description

Get a pipeline configuration by ID

Response

Returns a PipelineConfigurationResponseType!

Arguments
Name Description
pipelineConfigurationId - String!

Example

Query
query ReadPipelineConfiguration($pipelineConfigurationId: String!) {
  readPipelineConfiguration(pipelineConfigurationId: $pipelineConfigurationId) {
    nameLower
    pipelineConfigurationId
    groupId
    name
    description
    enabled
    trigger {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    steps {
      name
      description
      allowFailure
      type
      targetConfiguration {
        ...TargetConfigurationTypeFragment
      }
    }
    deviceIds
    projectIds
    licenseIds
    projectVersionIds
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
  }
}
Variables
{"pipelineConfigurationId": "xyz789"}
Response
{
  "data": {
    "readPipelineConfiguration": {
      "nameLower": "abc123",
      "pipelineConfigurationId": "xyz789",
      "groupId": "xyz789",
      "name": "abc123",
      "description": "xyz789",
      "enabled": false,
      "trigger": PipelineManualTriggerConfigurationType,
      "steps": [PipelineStepConfigurationType],
      "deviceIds": ["xyz789"],
      "projectIds": ["xyz789"],
      "licenseIds": ["xyz789"],
      "projectVersionIds": ["xyz789"],
      "objectVersion": 987,
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType
    }
  }
}
Queries

readPipelineExecution

Description

Get a pipeline execution by ID

Response

Returns a PipelineExecutionResponseType!

Arguments
Name Description
pipelineExecutionId - String!

Example

Query
query ReadPipelineExecution($pipelineExecutionId: String!) {
  readPipelineExecution(pipelineExecutionId: $pipelineExecutionId) {
    creationUserId
    updateUserId
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    pipelineExecutionId
    pipelineConfigurationId
    name
    triggerSource {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    status
    duration
    steps {
      name
      description
      allowFailure
      type
      targets {
        ...TargetExecutionStatusResponseTypeFragment
      }
      status
    }
    objectVersion
    creationTimestamp
    updateTimestamp
  }
}
Variables
{"pipelineExecutionId": "xyz789"}
Response
{
  "data": {
    "readPipelineExecution": {
      "creationUserId": "abc123",
      "updateUserId": "xyz789",
      "groupId": "abc123",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "pipelineExecutionId": "xyz789",
      "pipelineConfigurationId": "xyz789",
      "name": "abc123",
      "triggerSource": PipelineManualTriggerConfigurationType,
      "status": "SUCCESS",
      "duration": 123,
      "steps": [PipelineExecutionStepResponseType],
      "objectVersion": 987,
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

createJob

Response

Returns a JobResponseType!

Arguments
Name Description
job - CreateJobInput!

Example

Query
mutation CreateJob($job: CreateJobInput!) {
  createJob(job: $job) {
    jobId
    jobType
    vendorId
    ideConfigId
    pipelineConfigurationId
    pipelineExecutionId
    deviceIds
    projectIds
    projectVersionIds
    licenseIds
    status
    duration
    timeOut
    errorMessage
    startTimestamp
    finishedTimestamp
    featureOptions
    logStream
    logGroup
    metaData
    companyName
    meteringReservationId
    source
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    artifactsAvailable
  }
}
Variables
{"job": CreateJobInput}
Response
{
  "data": {
    "createJob": {
      "jobId": "xyz789",
      "jobType": "PROJECT_VIEW",
      "vendorId": "abc123",
      "ideConfigId": "xyz789",
      "pipelineConfigurationId": "abc123",
      "pipelineExecutionId": "abc123",
      "deviceIds": ["abc123"],
      "projectIds": ["abc123"],
      "projectVersionIds": ["abc123"],
      "licenseIds": ["xyz789"],
      "status": "SUCCESS",
      "duration": 123,
      "timeOut": 987,
      "errorMessage": "abc123",
      "startTimestamp": "2007-12-03T10:15:30Z",
      "finishedTimestamp": "2007-12-03T10:15:30Z",
      "featureOptions": {},
      "logStream": "abc123",
      "logGroup": "abc123",
      "metaData": {},
      "companyName": "xyz789",
      "meteringReservationId": "abc123",
      "source": "PIPELINE",
      "objectVersion": 123,
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "groupId": "abc123",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "artifactsAvailable": false
    }
  }
}
Mutations

createPipelineConfiguration

Response

Returns a PipelineConfigurationResponseType!

Arguments
Name Description
pipelineConfiguration - CreatePipelineConfigurationInput!

Example

Query
mutation CreatePipelineConfiguration($pipelineConfiguration: CreatePipelineConfigurationInput!) {
  createPipelineConfiguration(pipelineConfiguration: $pipelineConfiguration) {
    nameLower
    pipelineConfigurationId
    groupId
    name
    description
    enabled
    trigger {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    steps {
      name
      description
      allowFailure
      type
      targetConfiguration {
        ...TargetConfigurationTypeFragment
      }
    }
    deviceIds
    projectIds
    licenseIds
    projectVersionIds
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
  }
}
Variables
{
  "pipelineConfiguration": CreatePipelineConfigurationInput
}
Response
{
  "data": {
    "createPipelineConfiguration": {
      "nameLower": "xyz789",
      "pipelineConfigurationId": "abc123",
      "groupId": "xyz789",
      "name": "xyz789",
      "description": "xyz789",
      "enabled": false,
      "trigger": PipelineManualTriggerConfigurationType,
      "steps": [PipelineStepConfigurationType],
      "deviceIds": ["xyz789"],
      "projectIds": ["xyz789"],
      "licenseIds": ["xyz789"],
      "projectVersionIds": ["abc123"],
      "objectVersion": 123,
      "creationUserId": "abc123",
      "updateUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType
    }
  }
}
Mutations

deleteJob

Response

Returns a JobResponseType!

Arguments
Name Description
jobId - String!

Example

Query
mutation DeleteJob($jobId: String!) {
  deleteJob(jobId: $jobId) {
    jobId
    jobType
    vendorId
    ideConfigId
    pipelineConfigurationId
    pipelineExecutionId
    deviceIds
    projectIds
    projectVersionIds
    licenseIds
    status
    duration
    timeOut
    errorMessage
    startTimestamp
    finishedTimestamp
    featureOptions
    logStream
    logGroup
    metaData
    companyName
    meteringReservationId
    source
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    artifactsAvailable
  }
}
Variables
{"jobId": "xyz789"}
Response
{
  "data": {
    "deleteJob": {
      "jobId": "abc123",
      "jobType": "PROJECT_VIEW",
      "vendorId": "abc123",
      "ideConfigId": "abc123",
      "pipelineConfigurationId": "abc123",
      "pipelineExecutionId": "xyz789",
      "deviceIds": ["abc123"],
      "projectIds": ["xyz789"],
      "projectVersionIds": ["xyz789"],
      "licenseIds": ["abc123"],
      "status": "SUCCESS",
      "duration": 123,
      "timeOut": 123,
      "errorMessage": "abc123",
      "startTimestamp": "2007-12-03T10:15:30Z",
      "finishedTimestamp": "2007-12-03T10:15:30Z",
      "featureOptions": {},
      "logStream": "abc123",
      "logGroup": "xyz789",
      "metaData": {},
      "companyName": "xyz789",
      "meteringReservationId": "xyz789",
      "source": "PIPELINE",
      "objectVersion": 123,
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "groupId": "xyz789",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "artifactsAvailable": true
    }
  }
}
Mutations

deletePipelineConfiguration

Response

Returns a PipelineConfigurationResponseType!

Arguments
Name Description
pipelineConfigurationId - String!

Example

Query
mutation DeletePipelineConfiguration($pipelineConfigurationId: String!) {
  deletePipelineConfiguration(pipelineConfigurationId: $pipelineConfigurationId) {
    nameLower
    pipelineConfigurationId
    groupId
    name
    description
    enabled
    trigger {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    steps {
      name
      description
      allowFailure
      type
      targetConfiguration {
        ...TargetConfigurationTypeFragment
      }
    }
    deviceIds
    projectIds
    licenseIds
    projectVersionIds
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
  }
}
Variables
{"pipelineConfigurationId": "xyz789"}
Response
{
  "data": {
    "deletePipelineConfiguration": {
      "nameLower": "xyz789",
      "pipelineConfigurationId": "xyz789",
      "groupId": "abc123",
      "name": "abc123",
      "description": "abc123",
      "enabled": false,
      "trigger": PipelineManualTriggerConfigurationType,
      "steps": [PipelineStepConfigurationType],
      "deviceIds": ["xyz789"],
      "projectIds": ["abc123"],
      "licenseIds": ["abc123"],
      "projectVersionIds": ["abc123"],
      "objectVersion": 987,
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType
    }
  }
}
Mutations

deletePipelineExecution

Response

Returns a PipelineExecutionResponseType!

Arguments
Name Description
pipelineExecutionId - String!

Example

Query
mutation DeletePipelineExecution($pipelineExecutionId: String!) {
  deletePipelineExecution(pipelineExecutionId: $pipelineExecutionId) {
    creationUserId
    updateUserId
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    pipelineExecutionId
    pipelineConfigurationId
    name
    triggerSource {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    status
    duration
    steps {
      name
      description
      allowFailure
      type
      targets {
        ...TargetExecutionStatusResponseTypeFragment
      }
      status
    }
    objectVersion
    creationTimestamp
    updateTimestamp
  }
}
Variables
{"pipelineExecutionId": "xyz789"}
Response
{
  "data": {
    "deletePipelineExecution": {
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "groupId": "abc123",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "pipelineExecutionId": "abc123",
      "pipelineConfigurationId": "xyz789",
      "name": "xyz789",
      "triggerSource": PipelineManualTriggerConfigurationType,
      "status": "SUCCESS",
      "duration": 987,
      "steps": [PipelineExecutionStepResponseType],
      "objectVersion": 123,
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

downloadArtifactsForJob

Response

Returns a JobArtifactsResponseType!

Arguments
Name Description
jobId - String!

Example

Query
mutation DownloadArtifactsForJob($jobId: String!) {
  downloadArtifactsForJob(jobId: $jobId) {
    channel
    message
  }
}
Variables
{"jobId": "abc123"}
Response
{
  "data": {
    "downloadArtifactsForJob": {
      "channel": "xyz789",
      "message": "xyz789"
    }
  }
}
Mutations

generateUrlUploadArtifactFiles

Response

Returns [GenericArtifactResponseType!]!

Arguments
Name Description
request - GenericArtifactRequestInput!

Example

Query
mutation GenerateUrlUploadArtifactFiles($request: GenericArtifactRequestInput!) {
  generateUrlUploadArtifactFiles(request: $request) {
    presignedUrl
    fileName
    fileId
    message
  }
}
Variables
{"request": GenericArtifactRequestInput}
Response
{
  "data": {
    "generateUrlUploadArtifactFiles": [
      {
        "presignedUrl": "abc123",
        "fileName": "xyz789",
        "fileId": "abc123",
        "message": "abc123"
      }
    ]
  }
}
Mutations

triggerPipelineExecution

Response

Returns a PipelineExecutionResponseType!

Arguments
Name Description
pipelineConfigurationId - String!

Example

Query
mutation TriggerPipelineExecution($pipelineConfigurationId: String!) {
  triggerPipelineExecution(pipelineConfigurationId: $pipelineConfigurationId) {
    creationUserId
    updateUserId
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    pipelineExecutionId
    pipelineConfigurationId
    name
    triggerSource {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    status
    duration
    steps {
      name
      description
      allowFailure
      type
      targets {
        ...TargetExecutionStatusResponseTypeFragment
      }
      status
    }
    objectVersion
    creationTimestamp
    updateTimestamp
  }
}
Variables
{"pipelineConfigurationId": "abc123"}
Response
{
  "data": {
    "triggerPipelineExecution": {
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "groupId": "xyz789",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "pipelineExecutionId": "abc123",
      "pipelineConfigurationId": "xyz789",
      "name": "abc123",
      "triggerSource": PipelineManualTriggerConfigurationType,
      "status": "SUCCESS",
      "duration": 987,
      "steps": [PipelineExecutionStepResponseType],
      "objectVersion": 123,
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateJob

Response

Returns a JobResponseType!

Arguments
Name Description
jobId - String!
input - UpdateJobInput!

Example

Query
mutation UpdateJob(
  $jobId: String!,
  $input: UpdateJobInput!
) {
  updateJob(
    jobId: $jobId,
    input: $input
  ) {
    jobId
    jobType
    vendorId
    ideConfigId
    pipelineConfigurationId
    pipelineExecutionId
    deviceIds
    projectIds
    projectVersionIds
    licenseIds
    status
    duration
    timeOut
    errorMessage
    startTimestamp
    finishedTimestamp
    featureOptions
    logStream
    logGroup
    metaData
    companyName
    meteringReservationId
    source
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    groupId
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
    artifactsAvailable
  }
}
Variables
{
  "jobId": "abc123",
  "input": UpdateJobInput
}
Response
{
  "data": {
    "updateJob": {
      "jobId": "abc123",
      "jobType": "PROJECT_VIEW",
      "vendorId": "xyz789",
      "ideConfigId": "xyz789",
      "pipelineConfigurationId": "xyz789",
      "pipelineExecutionId": "abc123",
      "deviceIds": ["abc123"],
      "projectIds": ["abc123"],
      "projectVersionIds": ["abc123"],
      "licenseIds": ["abc123"],
      "status": "SUCCESS",
      "duration": 987,
      "timeOut": 987,
      "errorMessage": "xyz789",
      "startTimestamp": "2007-12-03T10:15:30Z",
      "finishedTimestamp": "2007-12-03T10:15:30Z",
      "featureOptions": {},
      "logStream": "xyz789",
      "logGroup": "xyz789",
      "metaData": {},
      "companyName": "abc123",
      "meteringReservationId": "xyz789",
      "source": "PIPELINE",
      "objectVersion": 987,
      "creationUserId": "abc123",
      "updateUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "groupId": "xyz789",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType,
      "artifactsAvailable": false
    }
  }
}
Mutations

updatePipelineConfiguration

Response

Returns a PipelineConfigurationResponseType!

Arguments
Name Description
pipelineConfigurationId - String!
input - UpdatePipelineConfigurationInput!

Example

Query
mutation UpdatePipelineConfiguration(
  $pipelineConfigurationId: String!,
  $input: UpdatePipelineConfigurationInput!
) {
  updatePipelineConfiguration(
    pipelineConfigurationId: $pipelineConfigurationId,
    input: $input
  ) {
    nameLower
    pipelineConfigurationId
    groupId
    name
    description
    enabled
    trigger {
      ... on PipelineManualTriggerConfigurationType {
        ...PipelineManualTriggerConfigurationTypeFragment
      }
      ... on PipelineScheduledTriggerConfigurationType {
        ...PipelineScheduledTriggerConfigurationTypeFragment
      }
    }
    steps {
      name
      description
      allowFailure
      type
      targetConfiguration {
        ...TargetConfigurationTypeFragment
      }
    }
    deviceIds
    projectIds
    licenseIds
    projectVersionIds
    objectVersion
    creationUserId
    updateUserId
    creationTimestamp
    updateTimestamp
    creationUser {
      userId
      email
      firstName
      lastName
    }
    updateUser {
      userId
      email
      firstName
      lastName
    }
  }
}
Variables
{
  "pipelineConfigurationId": "abc123",
  "input": UpdatePipelineConfigurationInput
}
Response
{
  "data": {
    "updatePipelineConfiguration": {
      "nameLower": "abc123",
      "pipelineConfigurationId": "xyz789",
      "groupId": "abc123",
      "name": "xyz789",
      "description": "abc123",
      "enabled": false,
      "trigger": PipelineManualTriggerConfigurationType,
      "steps": [PipelineStepConfigurationType],
      "deviceIds": ["abc123"],
      "projectIds": ["abc123"],
      "licenseIds": ["abc123"],
      "projectVersionIds": ["xyz789"],
      "objectVersion": 123,
      "creationUserId": "xyz789",
      "updateUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "creationUser": UserResponseType,
      "updateUser": UserResponseType
    }
  }
}

Types

ArtifactStatus

Values
Enum Value Description

READY

PROCESSING

NOT_FOUND
Example
"READY"
Types

ArtifactsResponseType

Fields
Field Name Description
presignedUrl - String
status - ArtifactStatus
message - String
Example
{
  "presignedUrl": "xyz789",
  "status": "READY",
  "message": "abc123"
}
Types

BaseResponseInterface

Fields
Field Name Description
creationUserId - String
updateUserId - String
groupId - String
Possible Types
BaseResponseInterface Types

JobResponseType

PipelineConfigurationResponseType

PipelineExecutionResponseType
Example
{
  "creationUserId": "xyz789",
  "updateUserId": "xyz789",
  "groupId": "xyz789"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BooleanFilterInput

Fields
Input Field Description
eq - Boolean
ne - Boolean
doNotIgnoreNullable - [FilterOperatorEnum!]
Example
{"eq": false, "ne": false, "doNotIgnoreNullable": ["eq"]}
Types

CreateJobInput

Fields
Input Field Description
jobType - FeatureEnum!
vendorId - String
ideConfigId - String
pipelineConfigurationId - String
pipelineExecutionId - String
deviceIds - [String!]
projectIds - [String!]
projectVersionIds - [String!]
licenseIds - [String!]
duration - Int
timeOut - Int
errorMessage - String
startTimestamp - DateTime
finishedTimestamp - DateTime
featureOptions - JSON
logStream - String
logGroup - String
metaData - JSON
companyName - String
meteringReservationId - String
source - JobSourceEnum
Example
{
  "jobType": "PROJECT_VIEW",
  "vendorId": "xyz789",
  "ideConfigId": "abc123",
  "pipelineConfigurationId": "xyz789",
  "pipelineExecutionId": "xyz789",
  "deviceIds": ["abc123"],
  "projectIds": ["xyz789"],
  "projectVersionIds": ["xyz789"],
  "licenseIds": ["xyz789"],
  "duration": 987,
  "timeOut": 987,
  "errorMessage": "xyz789",
  "startTimestamp": "2007-12-03T10:15:30Z",
  "finishedTimestamp": "2007-12-03T10:15:30Z",
  "featureOptions": {},
  "logStream": "abc123",
  "logGroup": "abc123",
  "metaData": {},
  "companyName": "xyz789",
  "meteringReservationId": "abc123",
  "source": "PIPELINE"
}
Types

CreatePipelineConfigurationInput

Fields
Input Field Description
groupId - String
name - String!
description - String
enabled - Boolean!
trigger - PipelineTriggerConfigurationCombinedInput!
steps - [PipelineStepConfigurationInput!]!
deviceIds - [String!]!
projectIds - [String!]!
licenseIds - [String!]!
projectVersionIds - [String!]!
Example
{
  "groupId": "xyz789",
  "name": "xyz789",
  "description": "abc123",
  "enabled": false,
  "trigger": PipelineTriggerConfigurationCombinedInput,
  "steps": [PipelineStepConfigurationInput],
  "deviceIds": ["xyz789"],
  "projectIds": ["abc123"],
  "licenseIds": ["abc123"],
  "projectVersionIds": ["abc123"]
}
Types

DateTime

Description

Date with time (isoformat)

Example
"2007-12-03T10:15:30Z"
Types

FeatureEnum

Values
Enum Value Description

PROJECT_VIEW

PROJECT_BACKUP

FTP_BACKUP

SMB_BACKUP

READ_VARIABLE_LIST_FROM_DEVICE

DEVICE_SNAPSHOT

PROJECT_MERGE

PROJECT_CONVERT

PROJECT_LIBRARY_UPGRADE

PROJECT_UPDATE_OPC_UA_INTERFACE

DEVICE_SNAPSHOT_RESTORE

WRITE_VARIABLE_LIST_TO_DEVICE

DEVICE_FIRMWARE_UPDATE

DEVICE_PASSWORD_UPDATE

DEPLOYMENT

LICENSE_VALIDATE

IDEAAS
Example
"PROJECT_VIEW"
Types

FilterOperatorEnum

Values
Enum Value Description

eq

ne

contains

not_contains

begins_with

in_

gt

lt

gte

lte

between

contains_any
Example
"eq"
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

GenericArtifactRequestInput

Fields
Input Field Description
fileNames - [String!]!
Example
{"fileNames": ["xyz789"]}
Types

GenericArtifactResponseType

Fields
Field Name Description
presignedUrl - String!
fileName - String!
fileId - String!
message - String
Example
{
  "presignedUrl": "xyz789",
  "fileName": "xyz789",
  "fileId": "xyz789",
  "message": "abc123"
}
Types

HealthResponseType

Fields
Field Name Description
status - String!
message - String!
Example
{
  "status": "xyz789",
  "message": "abc123"
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

JSON

Description

The JSON scalar type represents JSON values as specified by ECMA-404.

Example
{}
Types

JobArtifactsResponseType

Fields
Field Name Description
channel - String
message - String
Example
{
  "channel": "xyz789",
  "message": "abc123"
}
Types

JobFilterInput

Fields
Input Field Description
jobType - StringFilterInput
status - StringFilterInput
projectIds - StringFilterInput
deviceIds - StringFilterInput
licenseIds - StringFilterInput
projectVersionIds - StringFilterInput
ideConfigId - StringFilterInput
creationTimestamp - StringFilterInput
Example
{
  "jobType": StringFilterInput,
  "status": StringFilterInput,
  "projectIds": StringFilterInput,
  "deviceIds": StringFilterInput,
  "licenseIds": StringFilterInput,
  "projectVersionIds": StringFilterInput,
  "ideConfigId": StringFilterInput,
  "creationTimestamp": StringFilterInput
}
Types

JobLogType

Fields
Field Name Description
timestamp - String!
message - String!
Example
{
  "timestamp": "xyz789",
  "message": "xyz789"
}
Types

JobLogsFilterInput

Fields
Input Field Description
startTime - NumberFilterInput
endTime - NumberFilterInput
limit - NumberFilterInput
nextToken - StringFilterInput
Example
{
  "startTime": NumberFilterInput,
  "endTime": NumberFilterInput,
  "limit": NumberFilterInput,
  "nextToken": StringFilterInput
}
Types

JobLogsResponseType

Fields
Field Name Description
logs - [JobLogType!]!
nextToken - String
Example
{
  "logs": [JobLogType],
  "nextToken": "xyz789"
}
Types

JobResponseType

Fields
Field Name Description
jobId - String!
jobType - FeatureEnum!
vendorId - String!
ideConfigId - String!
pipelineConfigurationId - String
pipelineExecutionId - String
deviceIds - [String!]
projectIds - [String!]
projectVersionIds - [String!]
licenseIds - [String!]
status - JobStatusEnum!
duration - Int
timeOut - Int
errorMessage - String
startTimestamp - DateTime
finishedTimestamp - DateTime
featureOptions - JSON
logStream - String!
logGroup - String!
metaData - JSON
companyName - String
meteringReservationId - String
source - JobSourceEnum
objectVersion - Int
creationUserId - String
updateUserId - String
creationTimestamp - DateTime
updateTimestamp - DateTime
groupId - String
creationUser - UserResponseType
updateUser - UserResponseType
artifactsAvailable - Boolean!
Example
{
  "jobId": "xyz789",
  "jobType": "PROJECT_VIEW",
  "vendorId": "xyz789",
  "ideConfigId": "abc123",
  "pipelineConfigurationId": "abc123",
  "pipelineExecutionId": "xyz789",
  "deviceIds": ["xyz789"],
  "projectIds": ["xyz789"],
  "projectVersionIds": ["abc123"],
  "licenseIds": ["xyz789"],
  "status": "SUCCESS",
  "duration": 123,
  "timeOut": 123,
  "errorMessage": "abc123",
  "startTimestamp": "2007-12-03T10:15:30Z",
  "finishedTimestamp": "2007-12-03T10:15:30Z",
  "featureOptions": {},
  "logStream": "abc123",
  "logGroup": "abc123",
  "metaData": {},
  "companyName": "abc123",
  "meteringReservationId": "abc123",
  "source": "PIPELINE",
  "objectVersion": 123,
  "creationUserId": "xyz789",
  "updateUserId": "xyz789",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "groupId": "xyz789",
  "creationUser": UserResponseType,
  "updateUser": UserResponseType,
  "artifactsAvailable": true
}
Types

JobSourceEnum

Values
Enum Value Description

PIPELINE

API

EVENT

WEB_CONSOLE
Example
"PIPELINE"
Types

JobStatusEnum

Values
Enum Value Description

SUCCESS

FAILED

CANCELED

PENDING

SKIPPED

PROCESSING

TIMED_OUT
Example
"SUCCESS"
Types

NumberFilterInput

Fields
Input Field Description
eq - Float
ne - Float
gt - Float
lt - Float
gte - Float
lte - Float
in_ - [Float!]
between - [Float!]
doNotIgnoreNullable - [FilterOperatorEnum!]
Example
{
  "eq": 987.65,
  "ne": 987.65,
  "gt": 987.65,
  "lt": 123.45,
  "gte": 987.65,
  "lte": 987.65,
  "in_": [987.65],
  "between": [987.65],
  "doNotIgnoreNullable": ["eq"]
}
Types

PaginatedJobResponseType

Fields
Field Name Description
pages - Int!
items - [JobResponseType]!
itemCount - Int!
Example
{
  "pages": 987,
  "items": [JobResponseType],
  "itemCount": 987
}
Types

PaginatedPipelineConfigurationResponseType

Fields
Field Name Description
pages - Int!
items - [PipelineConfigurationResponseType]!
itemCount - Int!
Example
{
  "pages": 987,
  "items": [PipelineConfigurationResponseType],
  "itemCount": 987
}
Types

PaginatedPipelineExecutionResponseType

Fields
Field Name Description
pages - Int!
items - [PipelineExecutionResponseType]!
itemCount - Int!
Example
{
  "pages": 123,
  "items": [PipelineExecutionResponseType],
  "itemCount": 123
}
Types

PaginationInput

Fields
Input Field Description
pageSize - Int
page - Int
Example
{"pageSize": 987, "page": 987}
Types

PipelineConfigurationFilterInput

Fields
Input Field Description
name - StringFilterInput
nameLower - StringFilterInput
enabled - BooleanFilterInput
projectIds - StringFilterInput
deviceIds - StringFilterInput
tag - StringFilterIgnoreDdbInput
groupId - StringFilterInput
creationTimestamp - StringFilterInput
Example
{
  "name": StringFilterInput,
  "nameLower": StringFilterInput,
  "enabled": BooleanFilterInput,
  "projectIds": StringFilterInput,
  "deviceIds": StringFilterInput,
  "tag": StringFilterIgnoreDdbInput,
  "groupId": StringFilterInput,
  "creationTimestamp": StringFilterInput
}
Types

PipelineConfigurationResponseType

Fields
Field Name Description
nameLower - String
pipelineConfigurationId - String!
groupId - String
name - String!
description - String
enabled - Boolean!
trigger - PipelineTriggerConfigurationType!
steps - [PipelineStepConfigurationType!]!
deviceIds - [String!]!
projectIds - [String!]!
licenseIds - [String!]!
projectVersionIds - [String!]!
objectVersion - Int
creationUserId - String
updateUserId - String
creationTimestamp - DateTime
updateTimestamp - DateTime
creationUser - UserResponseType
updateUser - UserResponseType
Example
{
  "nameLower": "abc123",
  "pipelineConfigurationId": "xyz789",
  "groupId": "xyz789",
  "name": "xyz789",
  "description": "abc123",
  "enabled": false,
  "trigger": PipelineManualTriggerConfigurationType,
  "steps": [PipelineStepConfigurationType],
  "deviceIds": ["abc123"],
  "projectIds": ["abc123"],
  "licenseIds": ["abc123"],
  "projectVersionIds": ["abc123"],
  "objectVersion": 123,
  "creationUserId": "abc123",
  "updateUserId": "abc123",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "creationUser": UserResponseType,
  "updateUser": UserResponseType
}
Types

PipelineExecutionFilterInput

Fields
Input Field Description
status - StringFilterInput
pipelineConfigurationId - StringFilterInput
triggerSource - StringFilterInput
creationTimestamp - StringFilterInput
Example
{
  "status": StringFilterInput,
  "pipelineConfigurationId": StringFilterInput,
  "triggerSource": StringFilterInput,
  "creationTimestamp": StringFilterInput
}
Types

PipelineExecutionResponseType

Fields
Field Name Description
creationUserId - String
updateUserId - String
groupId - String
creationUser - UserResponseType
updateUser - UserResponseType
pipelineExecutionId - String!
pipelineConfigurationId - String!
name - String
triggerSource - PipelineManualTriggerConfigurationTypePipelineScheduledTriggerConfigurationType!
status - PipelineExecutionStatusEnum!
duration - Int!
steps - [PipelineExecutionStepResponseType!]!
objectVersion - Int
creationTimestamp - DateTime
updateTimestamp - DateTime
Example
{
  "creationUserId": "xyz789",
  "updateUserId": "abc123",
  "groupId": "xyz789",
  "creationUser": UserResponseType,
  "updateUser": UserResponseType,
  "pipelineExecutionId": "abc123",
  "pipelineConfigurationId": "abc123",
  "name": "abc123",
  "triggerSource": PipelineManualTriggerConfigurationType,
  "status": "SUCCESS",
  "duration": 987,
  "steps": [PipelineExecutionStepResponseType],
  "objectVersion": 987,
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z"
}
Types

PipelineExecutionStatusEnum

Values
Enum Value Description

SUCCESS

FAILED

FAILED_IGNORE

CANCELED

PENDING

PROCESSING

TIMED_OUT

SKIPPED

NOT_STARTED

WARNING
Example
"SUCCESS"
Types

PipelineExecutionStepResponseType

Fields
Field Name Description
name - String
description - String
allowFailure - Boolean!
type - FeatureEnum!
targets - [TargetExecutionStatusResponseType!]!
status - PipelineExecutionStatusEnum!
Example
{
  "name": "abc123",
  "description": "xyz789",
  "allowFailure": true,
  "type": "PROJECT_VIEW",
  "targets": [TargetExecutionStatusResponseType],
  "status": "SUCCESS"
}
Types

PipelineManualTriggerConfigurationType

Fields
Field Name Description
type - PipelineTriggerSourceTypeEnum!
Example
{"type": "MANUAL"}
Types

PipelineManualTriggerConfigurationTypePipelineScheduledTriggerConfigurationType

Types
Union Types

PipelineManualTriggerConfigurationType

PipelineScheduledTriggerConfigurationType
Example
PipelineManualTriggerConfigurationType
Types

PipelineScheduleTypesEnum

Values
Enum Value Description

CRON

AT

RATE
Example
"CRON"
Types

PipelineScheduledTriggerConfigurationType

Fields
Field Name Description
type - PipelineTriggerSourceTypeEnum!
expression - String!
expressionTimezone - String
scheduleType - PipelineScheduleTypesEnum
Example
{
  "type": "MANUAL",
  "expression": "xyz789",
  "expressionTimezone": "abc123",
  "scheduleType": "CRON"
}
Types

PipelineStepConfigurationInput

Fields
Input Field Description
name - String
description - String
allowFailure - Boolean!
type - FeatureEnum!
targetConfiguration - [TargetConfigurationInput!]!
Example
{
  "name": "abc123",
  "description": "abc123",
  "allowFailure": true,
  "type": "PROJECT_VIEW",
  "targetConfiguration": [TargetConfigurationInput]
}
Types

PipelineStepConfigurationType

Fields
Field Name Description
name - String
description - String
allowFailure - Boolean!
type - FeatureEnum!
targetConfiguration - [TargetConfigurationType!]!
Example
{
  "name": "abc123",
  "description": "xyz789",
  "allowFailure": false,
  "type": "PROJECT_VIEW",
  "targetConfiguration": [TargetConfigurationType]
}
Types

PipelineTriggerConfigurationCombinedInput

Fields
Input Field Description
type - PipelineTriggerSourceTypeEnum!
expression - String
expressionTimezone - String
scheduleType - PipelineScheduleTypesEnum
Example
{
  "type": "MANUAL",
  "expression": "xyz789",
  "expressionTimezone": "xyz789",
  "scheduleType": "CRON"
}
Types

PipelineTriggerConfigurationType

Types
Union Types

PipelineManualTriggerConfigurationType

PipelineScheduledTriggerConfigurationType
Example
PipelineManualTriggerConfigurationType
Types

PipelineTriggerSourceTypeEnum

Values
Enum Value Description

MANUAL

SCHEDULED
Example
"MANUAL"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

StringFilterIgnoreDdbInput

Fields
Input Field Description
eq - String
ne - String
gt - String
lt - String
gte - String
lte - String
contains - String
containsAny - [String!]
notContains - String
beginsWith - String
in_ - [String!]
between - [String!]
doNotIgnoreNullable - [FilterOperatorEnum!]
ignoreForDdbQuery - Boolean!
Example
{
  "eq": "abc123",
  "ne": "xyz789",
  "gt": "xyz789",
  "lt": "xyz789",
  "gte": "abc123",
  "lte": "xyz789",
  "contains": "abc123",
  "containsAny": ["xyz789"],
  "notContains": "xyz789",
  "beginsWith": "xyz789",
  "in_": ["abc123"],
  "between": ["xyz789"],
  "doNotIgnoreNullable": ["eq"],
  "ignoreForDdbQuery": true
}
Types

StringFilterInput

Fields
Input Field Description
eq - String
ne - String
gt - String
lt - String
gte - String
lte - String
contains - String
containsAny - [String!]
notContains - String
beginsWith - String
in_ - [String!]
between - [String!]
doNotIgnoreNullable - [FilterOperatorEnum!]
Example
{
  "eq": "abc123",
  "ne": "abc123",
  "gt": "xyz789",
  "lt": "abc123",
  "gte": "abc123",
  "lte": "xyz789",
  "contains": "xyz789",
  "containsAny": ["abc123"],
  "notContains": "xyz789",
  "beginsWith": "abc123",
  "in_": ["xyz789"],
  "between": ["abc123"],
  "doNotIgnoreNullable": ["eq"]
}
Types

TargetConfigurationInput

Fields
Input Field Description
projectIds - [String!]
deviceIds - [String!]
licenseIds - [String!]
projectVersionIds - [String!]
targetMetadata - JSON
Example
{
  "projectIds": ["xyz789"],
  "deviceIds": ["abc123"],
  "licenseIds": ["abc123"],
  "projectVersionIds": ["xyz789"],
  "targetMetadata": {}
}
Types

TargetConfigurationType

Fields
Field Name Description
projectIds - [String!]
deviceIds - [String!]
licenseIds - [String!]
projectVersionIds - [String!]
targetMetadata - JSON
Example
{
  "projectIds": ["abc123"],
  "deviceIds": ["xyz789"],
  "licenseIds": ["abc123"],
  "projectVersionIds": ["abc123"],
  "targetMetadata": {}
}
Types

TargetExecutionStatusResponseType

Fields
Field Name Description
projectIds - [String!]
deviceIds - [String!]
licenseIds - [String!]
projectVersionIds - [String!]
targetMetadata - JSON
jobId - String
status - PipelineExecutionStatusEnum!
Example
{
  "projectIds": ["xyz789"],
  "deviceIds": ["xyz789"],
  "licenseIds": ["xyz789"],
  "projectVersionIds": ["xyz789"],
  "targetMetadata": {},
  "jobId": "xyz789",
  "status": "SUCCESS"
}
Types

UpdateJobInput

Fields
Input Field Description
jobType - FeatureEnum
vendorId - String
ideConfigId - String
pipelineConfigurationId - String
pipelineExecutionId - String
deviceIds - [String!]
projectIds - [String!]
projectVersionIds - [String!]
licenseIds - [String!]
status - JobStatusEnum
duration - Int
timeOut - Int
errorMessage - String
startTimestamp - DateTime
finishedTimestamp - DateTime
featureOptions - JSON
logStream - String
logGroup - String
metaData - JSON
companyName - String
meteringReservationId - String
source - JobSourceEnum
objectVersion - Int
Example
{
  "jobType": "PROJECT_VIEW",
  "vendorId": "abc123",
  "ideConfigId": "abc123",
  "pipelineConfigurationId": "abc123",
  "pipelineExecutionId": "xyz789",
  "deviceIds": ["xyz789"],
  "projectIds": ["abc123"],
  "projectVersionIds": ["abc123"],
  "licenseIds": ["xyz789"],
  "status": "SUCCESS",
  "duration": 123,
  "timeOut": 987,
  "errorMessage": "abc123",
  "startTimestamp": "2007-12-03T10:15:30Z",
  "finishedTimestamp": "2007-12-03T10:15:30Z",
  "featureOptions": {},
  "logStream": "abc123",
  "logGroup": "abc123",
  "metaData": {},
  "companyName": "xyz789",
  "meteringReservationId": "abc123",
  "source": "PIPELINE",
  "objectVersion": 987
}
Types

UpdatePipelineConfigurationInput

Fields
Input Field Description
groupId - String
name - String
description - String
enabled - Boolean
trigger - PipelineTriggerConfigurationCombinedInput!
steps - [PipelineStepConfigurationInput!]
deviceIds - [String!]
projectIds - [String!]
licenseIds - [String!]
projectVersionIds - [String!]
objectVersion - Int
Example
{
  "groupId": "abc123",
  "name": "xyz789",
  "description": "abc123",
  "enabled": false,
  "trigger": PipelineTriggerConfigurationCombinedInput,
  "steps": [PipelineStepConfigurationInput],
  "deviceIds": ["xyz789"],
  "projectIds": ["abc123"],
  "licenseIds": ["xyz789"],
  "projectVersionIds": ["xyz789"],
  "objectVersion": 987
}
Types

UserResponseType

Fields
Field Name Description
userId - String!
email - String!
firstName - String!
lastName - String!
Example
{
  "userId": "xyz789",
  "email": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789"
}
Documentation by Anvil SpectaQL