Obtener una lista de transacciones

Una lista de todas las transacciones activas o completadas se puede utilizar para:

Hacer un seguimiento de las transacciones activas que se encuentran actualmente en la etapa de revisión manual.
Obtener un enlace de revisión manual para transacciones activas.
Descargar los archivos de resultados de las transacciones completadas.

Puede obtener una lista de transacciones con sus identificadores mediante la Vantage API. Puede usar Skill Monitor para aplicar filtros más avanzados.

Lista de transacciones activas

Para obtener una lista de transacciones activas, envíe una solicitud GET al recurso transactions/active. En el cuerpo de la solicitud, especifique los siguientes parámetros:

Parameter	Description
StageType	La etapa de la transacción. Los valores posibles son: - ManuaReview - CustomActivity - Automatic (todas las etapas en las que no se requiere intervención del usuario, por ejemplo, la extracción de campos)
StageName	El nombre de la acción específica (solo para la etapa ManualReview).
SkillId	El identificador de la skill. Si no se especifica un valor, se tendrán en cuenta todas las skills disponibles.
SkillVersion	La versión de la skill. Si no se especifica un valor, se tendrán en cuenta todas las versiones de las skills disponibles.
StartDate	La hora de creación de la transacción más antigua (debe especificarse en formato UTC).
EndDate	La hora de creación de la transacción más reciente (debe especificarse en formato UTC). Si no se especifica este valor, se utilizará la hora UTC actual.
TransactionParameters	La lista de parámetros de la transacción compuesta por pares clave-valor de tipo cadena. Estos parámetros proporcionan información adicional sobre el usuario (por ejemplo, el nombre del cliente). Los parámetros deben proporcionarse en el siguiente formato: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La lista de parámetros del documento compuesta por pares clave-valor de tipo cadena. Estos parámetros proporcionan información adicional sobre el documento (por ejemplo, el nombre del archivo). Los parámetros deben proporcionarse en el siguiente formato: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	El desplazamiento de paginación. El valor predeterminado del parámetro es 0.
Limit	El límite de paginación. El parámetro es obligatorio. El valor predeterminado del parámetro es 0.

Ejemplo de solicitud: La respuesta a una solicitud que incluya un identificador de skill contendrá un archivo JSON similar al siguiente:

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}

La respuesta a una solicitud en la que se especifiquen una etapa y una acción contendrá un archivo JSON con todas las transacciones activas, similar al siguiente:

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}

También puede obtener un enlace del cliente de revisión manual para transacciones activas. Para hacerlo, envíe una solicitud GET al recurso transactions/<transaction_id> con el identificador de la transacción en el URI de la solicitud. Solicitud de ejemplo: La respuesta incluirá un código similar al siguiente: La clave manualReviewLink contendrá un enlace a la interfaz web del cliente de revisión manual y un token de acceso de Vantage, si se requiere revisión manual. Este enlace y token se pueden usar para revisar y corregir los resultados de clasificación y extracción de campos de una transacción en particular. El enlace proporcionado es válido durante 168 horas, tras lo cual se debe crear y obtener un nuevo enlace para otro período de 168 horas utilizando el mismo método. Para obtener más información, consulte Integración de la revisión manual.

Los usuarios autorizados mediante este enlace no podrán ver ni modificar ningún otro documento ni transacción.

Lista de transacciones completadas

Para obtener una lista de transacciones completadas, envíe una solicitud GET al recurso transactions/completed. En el cuerpo de la solicitud, especifique los parámetros:

Parameter	Description
TransactionStatus	El estado de la transacción. Los valores posibles son: - Processed - Canceled - Failed
SkillId	El identificador de la skill. Si no se especifica ningún valor, se considerarán todas las skills disponibles.
SkillVersion	La versión de la skill. Si no se especifica ningún valor, se considerarán todas las versiones de las skills disponibles.
StartDate	La hora de creación de la transacción más antigua (debe especificarse en formato UTC).
EndDate	La hora de creación de la transacción más reciente (debe especificarse en formato UTC). Si no se especifica este valor, se utilizará la hora UTC actual.
TransactionParameters	La lista de parámetros de transacción compuesta por pares clave-valor de tipo string. Estos parámetros proporcionan información adicional del usuario (por ejemplo, el nombre del cliente). Los parámetros deben proporcionarse en el siguiente formato: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La lista de parámetros de documento compuesta por pares clave-valor de tipo string. Estos parámetros proporcionan información adicional del documento (por ejemplo, el nombre del archivo). Los parámetros deben proporcionarse en el siguiente formato: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	El desplazamiento de paginación. El valor predeterminado del parámetro es 0.
Limit	El límite de paginación. El parámetro es obligatorio. El valor predeterminado del parámetro es 0.

La respuesta contendrá un archivo JSON con todas las transacciones completadas y el número de páginas procesadas similar al siguiente:

{
  "items": [
    {
      "status": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

Información general

Guía del desarrollador

Obtener una lista de transacciones

Lista de transacciones activas

Lista de transacciones completadas

​Lista de transacciones activas

​Lista de transacciones completadas

Lista de transacciones activas

Lista de transacciones completadas