Compartir a través de


Jobs - Get

Obtención de un trabajo por identificador
Obtenga detalles sobre un trabajo en ejecución o completado por identificador de trabajo.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

Parámetros de identificador URI

Nombre En Requerido Tipo Description
baseDomain
path True

string

Dominio base para todas las solicitudes de servicio de Azure IoT Central.

jobId
path True

string

Id. único del trabajo.

Patrón de Regex: ^[a-zA-Z0-9_-]*$

subdomain
path True

string

Subdominio de aplicación.

api-version
query True

string

Versión de la API a la que se llama.

Respuestas

Nombre Tipo Description
200 OK

Job

Correcto

Other Status Codes

Error

Respuesta de error recibida del servicio IoT Central.

Encabezados

x-ms-error-code: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Get a job by ID

Solicitud de ejemplo

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Respuesta de muestra

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definiciones

Nombre Description
CloudPropertyJobData

Datos del trabajo de propiedad en la nube.

CommandJobData

Definición de datos del trabajo del comando.

DeviceTemplateMigrationJobData

Definición de datos del trabajo de migración de plantillas de dispositivo.

Error

Definición de error de respuesta.

ErrorDetails

Información detallada del error.

Job

Definición del trabajo.

JobBatch

Definición del lote del trabajo.

JobBatchType

Si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos.

JobCancellationThreshold

Definición del umbral de cancelación del trabajo.

JobCancellationThresholdType

Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos.

JobProgress

resumen del progreso de un trabajo programado.

PropertyJobData

Definición de datos del trabajo de propiedad.

CloudPropertyJobData

Datos del trabajo de propiedad en la nube.

Nombre Tipo Description
path

string

Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo.

target

string

Plantilla de dispositivo que define la funcionalidad de destino del trabajo.

type string:

cloudProperty

Tipo de los datos del trabajo.

value

AnyValue

Valor que se usa para actualizar la funcionalidad de destino, si existe.

CommandJobData

Definición de datos del trabajo del comando.

Nombre Tipo Description
path

string

Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo.

target

string

Plantilla de dispositivo que define la funcionalidad de destino del trabajo.

type string:

command

Tipo de los datos del trabajo.

value

AnyValue

Valor que se usa para actualizar la funcionalidad de destino, si existe.

DeviceTemplateMigrationJobData

Definición de datos del trabajo de migración de plantillas de dispositivo.

Nombre Tipo Description
template

string

Plantilla de dispositivo de destino a la que se migrarán los dispositivos.

type string:

deviceTemplateMigration

Tipo de los datos del trabajo.

Error

Definición de error de respuesta.

Nombre Tipo Description
error

ErrorDetails

Detalles del error de la solicitud actual.

ErrorDetails

Información detallada del error.

Nombre Tipo Description
code

string

Código de error.

message

string

Detalles del mensaje de error.

requestId

string

Id. de correlación para la solicitud actual.

time

string

La hora en que se produjo un error en la solicitud de error.

Job

Definición del trabajo.

Nombre Tipo Description
batch

JobBatch

Configuración de procesamiento por lotes para el trabajo.

cancellationThreshold

JobCancellationThreshold

Umbral de cancelación del trabajo.

data JobData[]:

Las funcionalidades que actualiza el trabajo y los valores con los que se actualizan.

description

string

Descripción detallada del trabajo.

displayName

string

Nombre para mostrar del trabajo.

end

string

Hora de finalización del trabajo

group

string

Identificador del grupo de dispositivos en el que se va a ejecutar el trabajo.

id

string

Id. único del trabajo.

organizations

string[]

Lista de organizaciones del trabajo, actualmente solo se admite una organización, se admitirán próximamente varias organizaciones.

progress

JobProgress

Estadísticas de progreso del trabajo.

scheduledJobId

string

Identificador de la definición de trabajo programada que creó este trabajo.

start

string

Hora de inicio del trabajo

status

string

Indica si el trabajo se está iniciando, ejecutando, etc.

JobBatch

Definición del lote del trabajo.

Nombre Tipo Description
type

JobBatchType

Si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos.

value

number

Número o porcentaje de dispositivos en los que se realiza el procesamiento por lotes.

JobBatchType

Si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos.

Nombre Tipo Description
number

string

Procesamiento por lotes de trabajos en función del número de dispositivos.

percentage

string

Porcentaje basado en procesamiento por lotes de trabajos de los dispositivos aplicados totales.

JobCancellationThreshold

Definición del umbral de cancelación del trabajo.

Nombre Tipo Description
batch

boolean

Si el umbral de cancelación se aplica por lote o al trabajo general.

type

JobCancellationThresholdType

Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos.

value

number

Número o porcentaje de dispositivos en los que se aplica el umbral de cancelación.

JobCancellationThresholdType

Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos.

Nombre Tipo Description
number

string

Umbral de cancelación de trabajos en función del número especificado de dispositivos.

percentage

string

Umbral de cancelación de trabajos en función del porcentaje de dispositivos totales.

JobProgress

resumen del progreso de un trabajo programado.

Nombre Tipo Description
completed

integer

Número de entidades para las que se ha completado el trabajo.

failed

integer

Número de entidades para las que se ha producido un error en el trabajo.

pending

integer

Número de entidades para las que el trabajo aún no se está ejecutando.

total

integer

Número total de entidades destinadas al trabajo.

PropertyJobData

Definición de datos del trabajo de propiedad.

Nombre Tipo Description
path

string

Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo.

target

string

Plantilla de dispositivo que define la funcionalidad de destino del trabajo.

type string:

property

Tipo de los datos del trabajo.

value

AnyValue

Valor que se usa para actualizar la funcionalidad de destino, si existe.