Zip Archive Decompress - State Solutions

Decompresses a zip archive and responds with the list of files and their associated content.

Version 1

HTTP Request
POST /ado/v1/ZipArchiveDecompress

Header

Parameter	Description
Ocp-Apim-Subscription-Key	The subscription key you received when you purchased a plan.

Request Body

Mandatory

Parameter	Type	Description
data	string	A base64 representation of the zip archive to decompress.

Optional

Parameter	Type	Description
getFileContents	boolean	Retrieve the contents of each file? If set to `false`, the contents of each file will be omitted in the response.

Common

Further Documentation: Common Parameters

Parameter	Type	Description
filter	String	A fully functioning SQL based WHERE statement that will filter the outgoing dataset to the records it determines as being included.
sortOrder	Object	Sorts the resulting dataset by the criteria provided. The object should contain property names that represent properties contained within the resulting dataset with a value corresponding to the desired sort direction (i.e. `ASC` or `DESC`).

Examples

Example

This example demonstrates a simple payload with the base64 representation of the zip file along with the GetFileContents parameter set to true.

Request

{
    "GetFileContents": true,
    "Data": "UEsDBBQAAAAAAKik2FYAAAAAAAAAAAAAAAAQAAAARmlsZXMvU3ViIExldmVsL1BLAwQUAAAAAADnpNhWp1Rh3ykAAAApAAAAIQAAAEZpbGVzL1N1YiBMZXZlbC9UZXN0IEZpbGUgMS4xLnR4dFRoaXMgaXMgdGhlIGNvbnRlbnRzIG9mIFRlc3QgRmlsZSAxLjEudHh0UEsDBBQAAAAAAOSk2FY6TonuKQAAACkAAAAhAAAARmlsZXMvU3ViIExldmVsL1Rlc3QgRmlsZSAyLjEudHh0VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDIuMS50eHRQSwMEFAAAAAAA4aTYVo5F/kgpAAAAKQAAACEAAABGaWxlcy9TdWIgTGV2ZWwvVGVzdCBGaWxlIDMuMS50eHRUaGlzIGlzIHRoZSBjb250ZW50cyBvZiBUZXN0IEZpbGUgMy4xLnR4dFBLAwQUAAAAAADdpNhWrwlGnycAAAAnAAAAFQAAAEZpbGVzL1RleHQgRmlsZSAxLnR4dFRoaXMgaXMgdGhlIGNvbnRlbnRzIG9mIFRlc3QgRmlsZSAxLnR4dFBLAwQUAAAAAADupNhWf3Pm2CcAAAAnAAAAFQAAAEZpbGVzL1RleHQgRmlsZSAyLnR4dFRoaXMgaXMgdGhlIGNvbnRlbnRzIG9mIFRlc3QgRmlsZSAyLnR4dFBLAwQUAAAAAAD0pNhWz1qG5ScAAAAnAAAAFQAAAEZpbGVzL1RleHQgRmlsZSAzLnR4dFRoaXMgaXMgdGhlIGNvbnRlbnRzIG9mIFRlc3QgRmlsZSAzLnR4dFBLAwQUAAAAAAD7pNhW34amVycAAAAnAAAAFQAAAEZpbGVzL1RleHQgRmlsZSA0LnR4dFRoaXMgaXMgdGhlIGNvbnRlbnRzIG9mIFRlc3QgRmlsZSA0LnR4dFBLAQIUABQAAAAAAKik2FYAAAAAAAAAAAAAAAAQAAAAAAAAAAAAEAAAAAAAAABGaWxlcy9TdWIgTGV2ZWwvUEsBAhQAFAAAAAAA56TYVqdUYd8pAAAAKQAAACEAAAAAAAAAAQAgAAAALgAAAEZpbGVzL1N1YiBMZXZlbC9UZXN0IEZpbGUgMS4xLnR4dFBLAQIUABQAAAAAAOSk2FY6TonuKQAAACkAAAAhAAAAAAAAAAEAIAAAAJYAAABGaWxlcy9TdWIgTGV2ZWwvVGVzdCBGaWxlIDIuMS50eHRQSwECFAAUAAAAAADhpNhWjkX+SCkAAAApAAAAIQAAAAAAAAABACAAAAD+AAAARmlsZXMvU3ViIExldmVsL1Rlc3QgRmlsZSAzLjEudHh0UEsBAhQAFAAAAAAA3aTYVq8JRp8nAAAAJwAAABUAAAAAAAAAAQAgAAAAZgEAAEZpbGVzL1RleHQgRmlsZSAxLnR4dFBLAQIUABQAAAAAAO6k2FZ/c+bYJwAAACcAAAAVAAAAAAAAAAEAIAAAAMABAABGaWxlcy9UZXh0IEZpbGUgMi50eHRQSwECFAAUAAAAAAD0pNhWz1qG5ScAAAAnAAAAFQAAAAAAAAABACAAAAAaAgAARmlsZXMvVGV4dCBGaWxlIDMudHh0UEsBAhQAFAAAAAAA+6TYVt+GplcnAAAAJwAAABUAAAAAAAAAAQAgAAAAdAIAAEZpbGVzL1RleHQgRmlsZSA0LnR4dFBLBQYAAAAACAAIADcCAADOAgAAAAA="
}
Code language: JSON / JSON with Comments (json)

Response

[
    {
        "Name": "",
        "Path": "Files/Sub Level/",
        "FileContent": "",
        "CompressedSize": 0,
        "UncompressedSize": 0
    },
    {
        "Name": "Test File 1.1.txt",
        "Path": "Files/Sub Level/Test File 1.1.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDEuMS50eHQ=",
        "CompressedSize": 41,
        "UncompressedSize": 41
    },
    {
        "Name": "Test File 2.1.txt",
        "Path": "Files/Sub Level/Test File 2.1.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDIuMS50eHQ=",
        "CompressedSize": 41,
        "UncompressedSize": 41
    },
    {
        "Name": "Test File 3.1.txt",
        "Path": "Files/Sub Level/Test File 3.1.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDMuMS50eHQ=",
        "CompressedSize": 41,
        "UncompressedSize": 41
    },
    {
        "Name": "Text File 1.txt",
        "Path": "Files/Text File 1.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDEudHh0",
        "CompressedSize": 39,
        "UncompressedSize": 39
    },
    {
        "Name": "Text File 2.txt",
        "Path": "Files/Text File 2.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDIudHh0",
        "CompressedSize": 39,
        "UncompressedSize": 39
    },
    {
        "Name": "Text File 3.txt",
        "Path": "Files/Text File 3.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDMudHh0",
        "CompressedSize": 39,
        "UncompressedSize": 39
    },
    {
        "Name": "Text File 4.txt",
        "Path": "Files/Text File 4.txt",
        "FileContent": "VGhpcyBpcyB0aGUgY29udGVudHMgb2YgVGVzdCBGaWxlIDQudHh0",
        "CompressedSize": 39,
        "UncompressedSize": 39
    }
]
Code language: JSON / JSON with Comments (json)