Las llamadas al servicio API RESTful de Data Mover incluyen los siguientes elementos:
- HTTPS está habilitado de forma predeterminada.
- Todas las llamadas a la interfaz RESTful de Data Mover devuelven un código de estado HTTPS que indica si la llamada se realizó correctamente.
Para obtener más información, consulte Códigos de estado de la API RESTFul.
- Algunas llamadas a la interfaz RESTful de Data Mover devuelven la información en el cuerpo de la respuesta con formato JSON.
- Una URL que identifica el servidor de Data Mover en el que se ejecuta el servicio REST, como https://dmprod:1443/datamover/jobs.dmprod, donde cada parte de la ruta define lo siguiente:
- dmprod: el alias DNS del servidor de Data Mover
- 1443: el puerto predeterminado en el que está escuchando el servicio REST
- /datamover/jobs: el recurso REST al que se hace referencia
- Cada llamada a la API RESTful de Data Mover se realiza mediante un método HTTPS específico: GET, POST, PUT o DELETE. El uso de diferentes métodos HTTPS en el mismo recurso REST produce resultados diferentes, como los siguientes ejemplos:
- El uso de GET en /datamover/jobs devuelve una lista de todos los trabajos de Data Mover
- El uso de POST en /datamover/jobs crea un trabajo nuevo
Todas las llamadas a la interfaz RESTful de Data Mover deben incluir un encabezado de aceptación (Accept) con la versión de la API que se utiliza. El encabezado proporcionado es un par de clave y valor. La clave es Accept y el valor de la versión actual es application/vnd.com.teradata.datamover-v1.0+json.
. - Algunas llamadas a la API RESTful de Data Mover requieren un parámetro de entrada. Los parámetros de entrada se especifican en el cuerpo de la solicitud en formato JSON o se proporcionan en la misma ruta URL.
Un ejemplo de la ruta URL es https://dmprod:1443/datamover/jobs/job-name?outputLevel=4, donde outputLevel=4 es un parámetro.