Creación de documentProcessingJob

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Cree un nuevo objeto documentProcessingJob . El trabajo de procesamiento de documentos pone en cola un documento, o todos los documentos de una carpeta, para que los procesen los modelos de contenido aplicados.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permiso con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Site.Manage.All	Site.Manage.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Site.Manage.All	Site.Manage.All

Solicitud HTTP

POST /sites/{sitesId}/documentProcessingJobs

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto documentProcessingJob .

Puede especificar las siguientes propiedades al crear un documentProcessingJob.

Propiedad	Tipo	Description
jobType	documentProcessingJobType	Tipo de trabajo de procesamiento de documentos. Los valores posibles son: File, Folder. Opcional.
status	documentProcessingJobStatus	Estado del trabajo de procesamiento de documentos. Los valores posibles son: inProgress, completed, failed y notStarted Normalmente, cuando se crea un trabajo, su estado inicial es notStarted. Opcional.
createdDateTime	DateTimeOffset	Fecha y hora de creación del elemento. Solo lectura. Opcional.
listItemUniqueId	Cadena	Identificador único del archivo o carpeta que se va a procesar. Para obtener el identificador único, use el método GET driveItem y lea la propiedad sharepointIds .

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto documentProcessingJob en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/beta/sites/ede4bb84-6c94-4c39-8acf-3d9dbb667fba/documentProcessingJobs
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.documentProcessingJob",
  "jobType": "File",
  "listItemUniqueId": "5955b119-99c1-4af9-97ed-3449e02de6f1",
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "11f99394-e5eb-45e9-b478-7c83eaeda224",
  "jobType": "File",
  "status": "notStarted",
  "createdDateTime": "2023-06-23T22:03:47",
  "listItemUniqueId": "5955b119-99c1-4af9-97ed-3449e02de6f1",
}