# Task Details
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/tasks/{taskName}:
get:
summary: Task Details
deprecated: false
description: >-
This endpoint allows you to list details of a specific task, including
status and exceptions.
### Required Permissions
`tasks.read`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Tasks
parameters:
- name: taskName
in: path
description: ''
required: true
example: ''
schema:
type: string
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: false
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: false
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: false
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: false
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: false
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Indicates that the task listing operation was successful.
task:
type: object
properties:
name:
type: string
description: The task's unique identifier.
appName:
type: string
description: The name of the app associated with the task.
buildName:
type: string
description: The build identifier related to the task.
taskType:
type: string
description: The type of the task (e.g., "dltar", "mkraw", etc.).
status:
type: string
description: The current state of the task.
steps:
type: object
properties:
created:
type: string
started:
type: string
finished:
type: string
required:
- created
- started
- finished
x-apidog-orders:
- created
- started
- finished
description: >-
An object with timestamps indicating when the task was
created, started, and finished.
x-apidog-ignore-properties: []
userData:
type: object
properties:
dltar:
type: object
properties:
url:
type: string
sizeBytes:
type: integer
x-apidog-orders:
- url
- sizeBytes
required:
- url
- sizeBytes
x-apidog-ignore-properties: []
x-apidog-orders:
- dltar
description: >-
An optional object providing additional details in
case of an exception such as, the URL and size (in
bytes) for a download task (typically under a property
like "dltar").
x-apidog-ignore-properties: []
alert:
type: object
properties:
exception:
type: object
properties:
httpDownloadFailed:
type: object
properties:
sizeBytesActual:
type: integer
sizeBytesExpected:
type: integer
httpStatus:
type: integer
exitCode:
type: integer
x-apidog-orders:
- sizeBytesActual
- sizeBytesExpected
- httpStatus
- 01JKTGRA47TR0ZN60HSVBHHBYM
x-apidog-refs:
01JKTGRA47TR0ZN60HSVBHHBYM:
$ref: >-
#/components/schemas/httpdownloadFailSchema
x-apidog-ignore-properties:
- exitCode
fileReadFailed:
type: object
properties:
filename:
type: string
typeExpected:
type: string
typeDetected:
type: string
x-apidog-orders:
- 01JKTFKKCACDMZYVEGCVM3DQ33
x-apidog-refs:
01JKTFKKCACDMZYVEGCVM3DQ33:
$ref: '#/components/schemas/wrongTarSchema'
required:
- filename
- typeExpected
- typeDetected
x-apidog-ignore-properties:
- filename
- typeExpected
- typeDetected
x-apidog-orders:
- httpDownloadFailed
- fileReadFailed
x-apidog-refs: {}
x-apidog-ignore-properties: []
x-apidog-orders:
- exception
required:
- exception
description: >-
An optional object in case of an exception details
(for instance, HTTP download failure information or
file read errors) if the task encountered warnings or
issues.
x-apidog-ignore-properties: []
results:
type: object
properties:
dltar:
type: object
properties:
sizeBytes:
type: number
description: >-
The size in bytes of the downloaded native
game build.
dlSpeedBpS:
type: number
description: >-
The average speed for the performed download
in bytes per second.
x-apidog-orders:
- sizeBytes
- dlSpeedBpS
description: Task results of `dltar` tasks.
required:
- sizeBytes
- dlSpeedBpS
x-apidog-ignore-properties: []
mkraw:
type: object
properties:
nFiles:
type: number
description: |
Number of files found in the game build.
sizeNativeBytes:
type: number
description: |
Size of the native game build in bytes,
sizeRAWBytes:
type: number
description: >-
Size of the generate ROCKIT RAW image in
bytes.
executables:
type: array
items:
type: string
description: >-
Array of all`*.exe` files found in the game
build.
x-apidog-orders:
- nFiles
- sizeNativeBytes
- sizeRAWBytes
- executables
description: Task results of `mkraw` tasks.
required:
- nFiles
- sizeNativeBytes
- sizeRAWBytes
- executables
x-apidog-ignore-properties: []
mkseq:
type: object
properties:
nTraces:
type: number
description: >-
Number of the unique initial traces in the
training state.
nTracesValid:
type: number
description: Number of valid traces received in the task.
nTracesStatistics:
type: number
description: Number of traces in the statistics data.
nReliable:
type: number
description: Number of reliable traces.
positionWeight:
type: number
description: Task input parameter.
timeWeight:
type: number
description: Task input parameter.
occurrenceWeight:
type: number
description: Task input parameter
enableTraceFiltering:
type: boolean
description: Trace filter mode
timeMin:
type: number
description: Minimum trace time.
timeReliable:
type: number
description: Reliable trace time.
coverageMin:
type: number
description: Minimum coverage
coverageSat:
type: number
description: Saturation coverage
coverageReliable:
type: number
description: Reliable coverage
updateDXF:
type: boolean
description: >-
If true an update of the DXF image will be
triggered.
overrideDXF:
type: boolean
description: If true, override DXF.
stopTraceUpload:
type: boolean
description: >-
If true, trace uploads will not be authorized
anymore.
initCoverage:
type: number
description: Initial coverage
newCoverage:
type: number
description: New coverage
maxQueue:
type: number
description: >-
Maximum request queue size in the OdR
simulation.
maxQueueDelayMS:
type: number
description: Maximum delay in msec in the OdR simulation.
nTracesCriticalQueue:
type: number
description: >-
Number of critical traces in the OdR
simulation.
criticalQueueDelayMS:
type: number
description: >-
Critical OdR queue delay in msec in the OdR
simulation.
maxFetchRate:
type: number
description: Maximum fetch rate.
maxRateDelayMS:
type: number
description: Delay in msec.
nTracesCriticalRate:
type: number
description: Number of traces
criticalRateDelayMS:
type: number
description: Critical rate in msec
x-apidog-orders:
- nTraces
- nTracesValid
- nTracesStatistics
- nReliable
- positionWeight
- timeWeight
- occurrenceWeight
- enableTraceFiltering
- timeMin
- timeReliable
- coverageMin
- coverageSat
- coverageReliable
- updateDXF
- overrideDXF
- stopTraceUpload
- initCoverage
- newCoverage
- maxQueue
- maxQueueDelayMS
- nTracesCriticalQueue
- criticalQueueDelayMS
- maxFetchRate
- maxRateDelayMS
- nTracesCriticalRate
- criticalRateDelayMS
description: Task results of `mkseq` tasks.
required:
- nTraces
- nTracesValid
- nTracesStatistics
- nReliable
- positionWeight
- timeWeight
- occurrenceWeight
- enableTraceFiltering
- timeMin
- timeReliable
- coverageMin
- coverageSat
- coverageReliable
- updateDXF
- overrideDXF
- stopTraceUpload
- initCoverage
- newCoverage
- maxQueue
- maxQueueDelayMS
- nTracesCriticalQueue
- criticalQueueDelayMS
- maxFetchRate
- maxRateDelayMS
- nTracesCriticalRate
- criticalRateDelayMS
x-apidog-ignore-properties: []
mkdxf:
type: object
properties:
timeWeight:
type: number
description: Time weight input parameter
positionWeight:
type: number
description: Position weight input parameter
occuranceWeight:
type: number
description: Occurance weight input parameter
nTracesStatistics:
type: number
description: >-
Number of unique initial traces in the
statistics
nReliable:
type: number
description: Number of unique initial traces
prepend:
type: boolean
description: >-
If true untrained data are located at the end
of the image file.
safe:
type: boolean
disk:
type: object
properties:
sizeDxf:
type: number
description: Size of the disk in bytes
sizeIdx:
type: number
description: Size of the index in bytes
sizeMnt:
type: number
description: Size of the mount sequence in bytes
mountMode:
type: string
description: Selected mount mode, e.g., "rtw"
x-apidog-orders:
- sizeDxf
- sizeIdx
- sizeMnt
- mountMode
description: ROCKIT disk parameters
required:
- sizeDxf
- sizeIdx
- sizeMnt
- mountMode
x-apidog-ignore-properties: []
loadprofile:
type: array
items:
type: object
properties:
time:
type: number
description: time in seconds
size:
type: number
description: size in bytes
x-apidog-orders:
- time
- size
required:
- time
- size
x-apidog-ignore-properties: []
description: Load profile data
analysis:
type: object
properties:
version:
type: number
description: File version
nTraces:
type: number
description: Number of traces
maxCoverage:
type: number
description: Maximum coverage in percent
maxCoverageReliable:
type: number
description: Maximum reliable coverage
maxTimeSecondsReliable:
type: number
description: Maximum reliable time in seconds
nBytesReliability0:
type: number
description: Number of bytes in reliability 0
nBytesReliability1:
type: number
description: Number of bytes in reliability 0
nBytesReliability2:
type: number
description: Number of bytes in reliability 0
loadprofile:
type: object
properties:
minutes:
type: array
items:
type: number
description: Array of minute buckets
bytes:
type: number
bytesR1:
type: number
bytesR2:
type: number
x-apidog-orders:
- minutes
- bytes
- bytesR1
- bytesR2
description: Load profile
required:
- minutes
- bytes
- bytesR1
- bytesR2
x-apidog-ignore-properties: []
preload:
type: object
properties:
bandwidth:
type: array
items:
type: number
description: bandwidth in Mbit/s
description: Array of bandwidths
bytes:
type: array
items:
type: number
x-apidog-orders:
- bandwidth
- bytes
description: Preload information
required:
- bandwidth
- bytes
x-apidog-ignore-properties: []
x-apidog-orders:
- version
- nTraces
- maxCoverage
- maxCoverageReliable
- maxTimeSecondsReliable
- nBytesReliability0
- nBytesReliability1
- nBytesReliability2
- loadprofile
- preload
description: Analysis results
required:
- version
- nTraces
- maxCoverage
- maxCoverageReliable
- maxTimeSecondsReliable
- nBytesReliability0
- nBytesReliability1
- nBytesReliability2
- loadprofile
- preload
x-apidog-ignore-properties: []
x-apidog-orders:
- timeWeight
- positionWeight
- occuranceWeight
- nTracesStatistics
- nReliable
- prepend
- safe
- disk
- loadprofile
- analysis
description: Task results of `mkdxf` tasks.
required:
- timeWeight
- positionWeight
- occuranceWeight
- nTracesStatistics
- nReliable
- prepend
- safe
- disk
- loadprofile
- analysis
x-apidog-ignore-properties: []
mkpat:
type: object
properties:
from:
type: string
description: Identifier of the source game build.
to:
type: string
description: Identifier of the destination game build.
reclaimable:
type: number
description: >-
Ratio of old image data that could be
identified in the new image.
The larger this number the more data of the
training state can be
reapplied to the new build.
patchSizeBytes:
type: number
description: Size of the generated patch in bytes.
x-apidog-orders:
- from
- to
- reclaimable
- patchSizeBytes
description: Task results of `mkpat` tasks.
required:
- from
- to
- reclaimable
- patchSizeBytes
x-apidog-ignore-properties: []
deploy:
type: object
properties:
deployments:
type: array
items:
type: object
properties:
deployment:
type: string
description: >-
Unique and immutable identifier of the
deployment.
uploadSpeedBpS:
type: number
description: >-
Average upload speed in bytes per
second.
x-apidog-orders:
- deployment
- uploadSpeedBpS
required:
- deployment
- uploadSpeedBpS
x-apidog-ignore-properties: []
description: List of deployment results
x-apidog-orders:
- deployments
description: Task results of `deploy` tasks.
required:
- deployments
x-apidog-ignore-properties: []
x-apidog-orders:
- dltar
- mkraw
- mkseq
- mkdxf
- mkpat
- deploy
description: Additional task results if available.
x-apidog-ignore-properties: []
required:
- name
- appName
- buildName
- taskType
- status
- steps
x-apidog-orders:
- name
- appName
- buildName
- taskType
- status
- steps
- userData
- alert
- results
description: >-
An object containing detailed information about the task,
including:
x-apidog-ignore-properties: []
required:
- status
- task
x-apidog-orders:
- status
- task
x-apidog-ignore-properties: []
examples:
'1':
summary: Success
value:
status: success
task:
name: ExampleOrg-sushi-0003-1739273968-dltar
appName: sushi
buildName: '0003'
taskType: dltar
status: failed
steps:
created: '2025-02-11T11:39:31.541Z'
started: '2025-02-11T11:40:16.504Z'
finished: '2025-02-11T11:40:52.577Z'
userData:
dltar:
url: >-
https://rockitplay-demo.akamaized.net/engine-fixtures/sushi/native-build.tar?token=exp=2041235666~acl=/engine-fixtures/sushi/*~hmac=df869da8c71a05f6a77ee7ed5a5902abd76e22734953d976973d6748d14beaf4
sizeBytes: 1788272645
alert:
exception:
httpDownloadFailed:
sizeBytesActual: 178827264
sizeBytesExpected: 1788272645
'2':
summary: '400: missing-param'
value:
status: failed
error: missing-param
message: x-rockit-beauth-token missing
detail: header parameter x-rockit-beauth-token is required
'3':
summary: '401: token-expired'
value:
status: failed
error: token-expired
message: expired token
headers: {}
x-apidog-name: OK
'400':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more
invalid or missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example,
"name invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected
pattern for the organization name)
x-apidog-orders:
- 01JQNHVBN3ZT4CTTYV55TFAG4Y
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNHVBN3ZT4CTTYV55TFAG4Y:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: '400: missing-param'
'401':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNHVPJW9M4BE8K1QJR0NJR4
required:
- status
- error
- message
x-apidog-refs:
01JQNHVPJW9M4BE8K1QJR0NJR4:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: '401: token-expired'
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Tasks
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-13899616-run
components:
schemas:
wrongTarSchema:
type: object
properties:
filename:
type: string
typeExpected:
type: string
typeDetected:
type: string
x-apidog-orders:
- filename
- typeExpected
- typeDetected
required:
- filename
- typeExpected
- typeDetected
x-apidog-ignore-properties: []
x-apidog-folder: ''
httpdownloadFailSchema:
type: object
properties:
exitCode:
type: integer
x-apidog-orders:
- exitCode
x-apidog-ignore-properties: []
x-apidog-folder: ''
Invalid Param:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more invalid or
missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example, "name
invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected pattern for the
organization name)
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```