GET api_v1/RecognitionPackages/GetPackageHierarchyProperties?recognitionPackageId={recognitionPackageId}

Запрос информации о пакете, и обо всех включенных в него файлах и документах

Request Information

Body Parameters

None.

Response Information

output может быть предоставлен в одном из следующих форматов:

json – задает вывод в формате JavaScript Object Notation (JSON)
xml – задает вывод в формате XML

Resource Description

PackageHierarchyPropertiesDTO

Name	Type	Additional information
Id	globally unique identifier	None.
OwnerId	globally unique identifier	None.
AccountId	globally unique identifier	None.
RecognitionTemplatesTypes	string	None.
CreateDate	date	None.
EditDate	date	None.
Status	PStatus	None.
Licenses	integer	None.
AbbyyLicenses	integer	None.
Type	RecognitionPackageContentType	None.
ExportPath	string	None.
PdfResultFileId	string	None.
WebDavLogin	string	None.
Comment	string	None.
RecognizedDocuments		None.

Response Formats

application/xml, text/xml

Sample:

<Result>
  <Id>24f57635-32c8-4f9d-8b77-cb4d48cdfcc3</Id>
  <OwnerId>bed96216-c7ff-4c19-8227-39709d41b757</OwnerId>
  <AccountId>d4a407fb-fca6-42c9-819a-1a8b9e4de560</AccountId>
  <RecognitionTemplatesTypes>sample string 4</RecognitionTemplatesTypes>
  <CreateDate>2026-05-12T15:12:56.3601262+03:00</CreateDate>
  <EditDate>2026-05-12T15:12:56.3601262+03:00</EditDate>
  <Status>New</Status>
  <Licenses>6</Licenses>
  <AbbyyLicenses>7</AbbyyLicenses>
  <Type>Scancopies</Type>
  <ExportPath>sample string 8</ExportPath>
  <PdfResultFileId>sample string 9</PdfResultFileId>
  <WebDavLogin>sample string 10</WebDavLogin>
  <Comment>sample string 11</Comment>
  <RecognizedDocuments type="sample string 1">
    <Row>
      <Id>9adde9d7-2aeb-4d1f-a356-03b28a8f1407</Id>
      <RecognitionPackageId>6d92986a-2ad6-4edd-8fb0-d475a23b59cb</RecognitionPackageId>
      <Status>TemplateAssigned</Status>
      <Type>sample string 3</Type>
      <ReserveType>sample string 4</ReserveType>
      <Accuracy>5.1</Accuracy>
      <CreateDate>2026-05-12T15:12:56.3601262+03:00</CreateDate>
      <EditDate>2026-05-12T15:12:56.3601262+03:00</EditDate>
      <XmlResultFileId>bcfd2534-2b92-4241-b0ad-e6f6517bed73</XmlResultFileId>
      <PdfResultFileId>a99b6e7d-f181-4538-b823-c49f4185a7cb</PdfResultFileId>
      <Comment>sample string 6</Comment>
      <DocumentPages type="sample string 1">
        <Row>
          <Id>8d232987-b3f7-4914-bce5-7488c876f25e</Id>
          <RecognizedDocumentId>d26d98e1-1602-4d43-9d61-d70eb97ed448</RecognizedDocumentId>
          <SourceFileId>c290d592-058e-419c-8db3-2998e35fed4b</SourceFileId>
          <PageNumber>4</PageNumber>
        </Row>
        <Row>
          <Id>8d232987-b3f7-4914-bce5-7488c876f25e</Id>
          <RecognizedDocumentId>d26d98e1-1602-4d43-9d61-d70eb97ed448</RecognizedDocumentId>
          <SourceFileId>c290d592-058e-419c-8db3-2998e35fed4b</SourceFileId>
          <PageNumber>4</PageNumber>
        </Row>
      </DocumentPages>
      <ResultFiles type="sample string 1">
        <Row>
          <Id>3317e3af-1765-45db-a153-50a9f1547ba7</Id>
          <RecognitionPackageId>f3b8cb75-652a-4381-9e73-10b5abe71406</RecognitionPackageId>
          <LocalPath>sample string 3</LocalPath>
          <Status>Ready</Status>
          <Comment>sample string 4</Comment>
        </Row>
        <Row>
          <Id>3317e3af-1765-45db-a153-50a9f1547ba7</Id>
          <RecognitionPackageId>f3b8cb75-652a-4381-9e73-10b5abe71406</RecognitionPackageId>
          <LocalPath>sample string 3</LocalPath>
          <Status>Ready</Status>
          <Comment>sample string 4</Comment>
        </Row>
      </ResultFiles>
      <SourceFiles type="sample string 1">
        <Row>
          <Id>0daa4355-698e-4598-b54c-be3e810fe62c</Id>
          <RecognitionPackageId>204e0d90-a7db-4632-ba5a-4f0051f0b710</RecognitionPackageId>
          <OriginalName>sample string 3</OriginalName>
          <Status>Ready</Status>
          <Type>sample string 4</Type>
          <Source>sample string 5</Source>
          <Comment>sample string 6</Comment>
          <PageCount>7</PageCount>
        </Row>
        <Row>
          <Id>0daa4355-698e-4598-b54c-be3e810fe62c</Id>
          <RecognitionPackageId>204e0d90-a7db-4632-ba5a-4f0051f0b710</RecognitionPackageId>
          <OriginalName>sample string 3</OriginalName>
          <Status>Ready</Status>
          <Type>sample string 4</Type>
          <Source>sample string 5</Source>
          <Comment>sample string 6</Comment>
          <PageCount>7</PageCount>
        </Row>
      </SourceFiles>
      <ClassificatedDocPages type="sample string 1">
        <Row>
          <Id>b661ae61-3d55-47e7-a924-89892f266040</Id>
          <RecognizedDocumentId>c2cdb891-a7ac-4c1f-905f-e600148bd2ba</RecognizedDocumentId>
          <SourceFileId>a9bdd71d-0424-4109-a6cc-b1e06a01f3a0</SourceFileId>
          <RecognitionTemplatesTypes>sample string 4</RecognitionTemplatesTypes>
          <OrderInDoc>5</OrderInDoc>
          <Path>sample string 6</Path>
        </Row>
        <Row>
          <Id>b661ae61-3d55-47e7-a924-89892f266040</Id>
          <RecognizedDocumentId>c2cdb891-a7ac-4c1f-905f-e600148bd2ba</RecognizedDocumentId>
          <SourceFileId>a9bdd71d-0424-4109-a6cc-b1e06a01f3a0</SourceFileId>
          <RecognitionTemplatesTypes>sample string 4</RecognitionTemplatesTypes>
          <OrderInDoc>5</OrderInDoc>
          <Path>sample string 6</Path>
        </Row>
      </ClassificatedDocPages>
    </Row>
    <Row>
      <Id>9adde9d7-2aeb-4d1f-a356-03b28a8f1407</Id>
      <RecognitionPackageId>6d92986a-2ad6-4edd-8fb0-d475a23b59cb</RecognitionPackageId>
      <Status>TemplateAssigned</Status>
      <Type>sample string 3</Type>
      <ReserveType>sample string 4</ReserveType>
      <Accuracy>5.1</Accuracy>
      <CreateDate>2026-05-12T15:12:56.3601262+03:00</CreateDate>
      <EditDate>2026-05-12T15:12:56.3601262+03:00</EditDate>
      <XmlResultFileId>bcfd2534-2b92-4241-b0ad-e6f6517bed73</XmlResultFileId>
      <PdfResultFileId>a99b6e7d-f181-4538-b823-c49f4185a7cb</PdfResultFileId>
      <Comment>sample string 6</Comment>
      <DocumentPages type="sample string 1">
        <Row>
          <Id>8d232987-b3f7-4914-bce5-7488c876f25e</Id>
          <RecognizedDocumentId>d26d98e1-1602-4d43-9d61-d70eb97ed448</RecognizedDocumentId>
          <SourceFileId>c290d592-058e-419c-8db3-2998e35fed4b</SourceFileId>
          <PageNumber>4</PageNumber>
        </Row>
        <Row>
          <Id>8d232987-b3f7-4914-bce5-7488c876f25e</Id>
          <RecognizedDocumentId>d26d98e1-1602-4d43-9d61-d70eb97ed448</RecognizedDocumentId>
          <SourceFileId>c290d592-058e-419c-8db3-2998e35fed4b</SourceFileId>
          <PageNumber>4</PageNumber>
        </Row>
      </DocumentPages>
      <ResultFiles type="sample string 1">
        <Row>
          <Id>3317e3af-1765-45db-a153-50a9f1547ba7</Id>
          <RecognitionPackageId>f3b8cb75-652a-4381-9e73-10b5abe71406</RecognitionPackageId>
          <LocalPath>sample string 3</LocalPath>
          <Status>Ready</Status>
          <Comment>sample string 4</Comment>
        </Row>
        <Row>
          <Id>3317e3af-1765-45db-a153-50a9f1547ba7</Id>
          <RecognitionPackageId>f3b8cb75-652a-4381-9e73-10b5abe71406</RecognitionPackageId>
          <LocalPath>sample string 3</LocalPath>
          <Status>Ready</Status>
          <Comment>sample string 4</Comment>
        </Row>
      </ResultFiles>
      <SourceFiles type="sample string 1">
        <Row>
          <Id>0daa4355-698e-4598-b54c-be3e810fe62c</Id>
          <RecognitionPackageId>204e0d90-a7db-4632-ba5a-4f0051f0b710</RecognitionPackageId>
          <OriginalName>sample string 3</OriginalName>
          <Status>Ready</Status>
          <Type>sample string 4</Type>
          <Source>sample string 5</Source>
          <Comment>sample string 6</Comment>
          <PageCount>7</PageCount>
        </Row>
        <Row>
          <Id>0daa4355-698e-4598-b54c-be3e810fe62c</Id>
          <RecognitionPackageId>204e0d90-a7db-4632-ba5a-4f0051f0b710</RecognitionPackageId>
          <OriginalName>sample string 3</OriginalName>
          <Status>Ready</Status>
          <Type>sample string 4</Type>
          <Source>sample string 5</Source>
          <Comment>sample string 6</Comment>
          <PageCount>7</PageCount>
        </Row>
      </SourceFiles>
      <ClassificatedDocPages type="sample string 1">
        <Row>
          <Id>b661ae61-3d55-47e7-a924-89892f266040</Id>
          <RecognizedDocumentId>c2cdb891-a7ac-4c1f-905f-e600148bd2ba</RecognizedDocumentId>
          <SourceFileId>a9bdd71d-0424-4109-a6cc-b1e06a01f3a0</SourceFileId>
          <RecognitionTemplatesTypes>sample string 4</RecognitionTemplatesTypes>
          <OrderInDoc>5</OrderInDoc>
          <Path>sample string 6</Path>
        </Row>
        <Row>
          <Id>b661ae61-3d55-47e7-a924-89892f266040</Id>
          <RecognizedDocumentId>c2cdb891-a7ac-4c1f-905f-e600148bd2ba</RecognizedDocumentId>
          <SourceFileId>a9bdd71d-0424-4109-a6cc-b1e06a01f3a0</SourceFileId>
          <RecognitionTemplatesTypes>sample string 4</RecognitionTemplatesTypes>
          <OrderInDoc>5</OrderInDoc>
          <Path>sample string 6</Path>
        </Row>
      </ClassificatedDocPages>
    </Row>
  </RecognizedDocuments>
</Result>

application/json, text/json

Sample:

{
  "Id": "24f57635-32c8-4f9d-8b77-cb4d48cdfcc3",
  "OwnerId": "bed96216-c7ff-4c19-8227-39709d41b757",
  "AccountId": "d4a407fb-fca6-42c9-819a-1a8b9e4de560",
  "RecognitionTemplatesTypes": "sample string 4",
  "CreateDate": "2026-05-12T15:12:56.3601262+03:00",
  "EditDate": "2026-05-12T15:12:56.3601262+03:00",
  "Status": 0,
  "Licenses": 6,
  "AbbyyLicenses": 7,
  "Type": 0,
  "ExportPath": "sample string 8",
  "PdfResultFileId": "sample string 9",
  "WebDavLogin": "sample string 10",
  "Comment": "sample string 11",
  "RecognizedDocuments": {
    "List": [
      {
        "Id": "9adde9d7-2aeb-4d1f-a356-03b28a8f1407",
        "RecognitionPackageId": "6d92986a-2ad6-4edd-8fb0-d475a23b59cb",
        "Status": 0,
        "Type": "sample string 3",
        "ReserveType": "sample string 4",
        "Accuracy": 5.1,
        "CreateDate": "2026-05-12T15:12:56.3601262+03:00",
        "EditDate": "2026-05-12T15:12:56.3601262+03:00",
        "XmlResultFileId": "bcfd2534-2b92-4241-b0ad-e6f6517bed73",
        "PdfResultFileId": "a99b6e7d-f181-4538-b823-c49f4185a7cb",
        "Comment": "sample string 6",
        "DocumentPages": {
          "List": [
            {
              "Id": "8d232987-b3f7-4914-bce5-7488c876f25e",
              "RecognizedDocumentId": "d26d98e1-1602-4d43-9d61-d70eb97ed448",
              "SourceFileId": "c290d592-058e-419c-8db3-2998e35fed4b",
              "PageNumber": 4
            },
            {
              "Id": "8d232987-b3f7-4914-bce5-7488c876f25e",
              "RecognizedDocumentId": "d26d98e1-1602-4d43-9d61-d70eb97ed448",
              "SourceFileId": "c290d592-058e-419c-8db3-2998e35fed4b",
              "PageNumber": 4
            }
          ]
        },
        "ResultFiles": {
          "List": [
            {
              "Id": "3317e3af-1765-45db-a153-50a9f1547ba7",
              "RecognitionPackageId": "f3b8cb75-652a-4381-9e73-10b5abe71406",
              "LocalPath": "sample string 3",
              "Status": 1,
              "Comment": "sample string 4"
            },
            {
              "Id": "3317e3af-1765-45db-a153-50a9f1547ba7",
              "RecognitionPackageId": "f3b8cb75-652a-4381-9e73-10b5abe71406",
              "LocalPath": "sample string 3",
              "Status": 1,
              "Comment": "sample string 4"
            }
          ]
        },
        "SourceFiles": {
          "List": [
            {
              "Id": "0daa4355-698e-4598-b54c-be3e810fe62c",
              "RecognitionPackageId": "204e0d90-a7db-4632-ba5a-4f0051f0b710",
              "OriginalName": "sample string 3",
              "Status": 1,
              "Type": "sample string 4",
              "Source": "sample string 5",
              "Comment": "sample string 6",
              "PageCount": 7
            },
            {
              "Id": "0daa4355-698e-4598-b54c-be3e810fe62c",
              "RecognitionPackageId": "204e0d90-a7db-4632-ba5a-4f0051f0b710",
              "OriginalName": "sample string 3",
              "Status": 1,
              "Type": "sample string 4",
              "Source": "sample string 5",
              "Comment": "sample string 6",
              "PageCount": 7
            }
          ]
        },
        "ClassificatedDocPages": {
          "List": [
            {
              "Id": "b661ae61-3d55-47e7-a924-89892f266040",
              "RecognizedDocumentId": "c2cdb891-a7ac-4c1f-905f-e600148bd2ba",
              "SourceFileId": "a9bdd71d-0424-4109-a6cc-b1e06a01f3a0",
              "RecognitionTemplatesTypes": "sample string 4",
              "OrderInDoc": 5,
              "Path": "sample string 6"
            },
            {
              "Id": "b661ae61-3d55-47e7-a924-89892f266040",
              "RecognizedDocumentId": "c2cdb891-a7ac-4c1f-905f-e600148bd2ba",
              "SourceFileId": "a9bdd71d-0424-4109-a6cc-b1e06a01f3a0",
              "RecognitionTemplatesTypes": "sample string 4",
              "OrderInDoc": 5,
              "Path": "sample string 6"
            }
          ]
        }
      },
      {
        "Id": "9adde9d7-2aeb-4d1f-a356-03b28a8f1407",
        "RecognitionPackageId": "6d92986a-2ad6-4edd-8fb0-d475a23b59cb",
        "Status": 0,
        "Type": "sample string 3",
        "ReserveType": "sample string 4",
        "Accuracy": 5.1,
        "CreateDate": "2026-05-12T15:12:56.3601262+03:00",
        "EditDate": "2026-05-12T15:12:56.3601262+03:00",
        "XmlResultFileId": "bcfd2534-2b92-4241-b0ad-e6f6517bed73",
        "PdfResultFileId": "a99b6e7d-f181-4538-b823-c49f4185a7cb",
        "Comment": "sample string 6",
        "DocumentPages": {
          "List": [
            {
              "Id": "8d232987-b3f7-4914-bce5-7488c876f25e",
              "RecognizedDocumentId": "d26d98e1-1602-4d43-9d61-d70eb97ed448",
              "SourceFileId": "c290d592-058e-419c-8db3-2998e35fed4b",
              "PageNumber": 4
            },
            {
              "Id": "8d232987-b3f7-4914-bce5-7488c876f25e",
              "RecognizedDocumentId": "d26d98e1-1602-4d43-9d61-d70eb97ed448",
              "SourceFileId": "c290d592-058e-419c-8db3-2998e35fed4b",
              "PageNumber": 4
            }
          ]
        },
        "ResultFiles": {
          "List": [
            {
              "Id": "3317e3af-1765-45db-a153-50a9f1547ba7",
              "RecognitionPackageId": "f3b8cb75-652a-4381-9e73-10b5abe71406",
              "LocalPath": "sample string 3",
              "Status": 1,
              "Comment": "sample string 4"
            },
            {
              "Id": "3317e3af-1765-45db-a153-50a9f1547ba7",
              "RecognitionPackageId": "f3b8cb75-652a-4381-9e73-10b5abe71406",
              "LocalPath": "sample string 3",
              "Status": 1,
              "Comment": "sample string 4"
            }
          ]
        },
        "SourceFiles": {
          "List": [
            {
              "Id": "0daa4355-698e-4598-b54c-be3e810fe62c",
              "RecognitionPackageId": "204e0d90-a7db-4632-ba5a-4f0051f0b710",
              "OriginalName": "sample string 3",
              "Status": 1,
              "Type": "sample string 4",
              "Source": "sample string 5",
              "Comment": "sample string 6",
              "PageCount": 7
            },
            {
              "Id": "0daa4355-698e-4598-b54c-be3e810fe62c",
              "RecognitionPackageId": "204e0d90-a7db-4632-ba5a-4f0051f0b710",
              "OriginalName": "sample string 3",
              "Status": 1,
              "Type": "sample string 4",
              "Source": "sample string 5",
              "Comment": "sample string 6",
              "PageCount": 7
            }
          ]
        },
        "ClassificatedDocPages": {
          "List": [
            {
              "Id": "b661ae61-3d55-47e7-a924-89892f266040",
              "RecognizedDocumentId": "c2cdb891-a7ac-4c1f-905f-e600148bd2ba",
              "SourceFileId": "a9bdd71d-0424-4109-a6cc-b1e06a01f3a0",
              "RecognitionTemplatesTypes": "sample string 4",
              "OrderInDoc": 5,
              "Path": "sample string 6"
            },
            {
              "Id": "b661ae61-3d55-47e7-a924-89892f266040",
              "RecognizedDocumentId": "c2cdb891-a7ac-4c1f-905f-e600148bd2ba",
              "SourceFileId": "a9bdd71d-0424-4109-a6cc-b1e06a01f3a0",
              "RecognitionTemplatesTypes": "sample string 4",
              "OrderInDoc": 5,
              "Path": "sample string 6"
            }
          ]
        }
      }
    ]
  }
}