GET api/postman/{partnerID}/{apiKey}
Get a postman collection of all visible Api (Get the [POSTMAN](http://www.getpostman.com) chrome extension)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
partnerID | string |
Required |
|
apiKey | string |
Required |
Body Parameters
None.
Response Information
Resource Description
object describing a POSTMAN collection
PostmanCollectionGetName | Description | Type | Additional information |
---|---|---|---|
id |
Id of collection |
globally unique identifier |
None. |
name |
Name of collection |
string |
None. |
timestamp |
Collection generation time |
integer |
None. |
requests |
Requests associated with the collection |
Collection of PostmanRequestGet |
None. |
synced |
**unused always false** |
boolean |
None. |
folders |
folders within the collection |
Collection of PostmanFolderGet |
None. |
description |
Description of collection |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "id": "a60d4c55-a8a9-42f8-921e-017aaf15a76d", "name": "sample string 2", "timestamp": 3, "requests": [ { "id": "606ffa73-904f-4900-a288-88ff0ad1f617", "headers": [ "sample string 1", "sample string 2" ], "url": "sample string 2", "pathVariables": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "method": "sample string 3", "data": "sample string 4", "dataMode": "sample string 5", "name": "sample string 6", "description": "sample string 7", "descriptionFormat": "sample string 8", "time": 9, "version": "sample string 10", "responses": [ "sample string 1", "sample string 2" ], "collection-id": "bc514e1c-233f-4488-9f45-2094c6a77994", "synced": true }, { "id": "606ffa73-904f-4900-a288-88ff0ad1f617", "headers": [ "sample string 1", "sample string 2" ], "url": "sample string 2", "pathVariables": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "method": "sample string 3", "data": "sample string 4", "dataMode": "sample string 5", "name": "sample string 6", "description": "sample string 7", "descriptionFormat": "sample string 8", "time": 9, "version": "sample string 10", "responses": [ "sample string 1", "sample string 2" ], "collection-id": "bc514e1c-233f-4488-9f45-2094c6a77994", "synced": true } ], "synced": true, "folders": [ { "id": "f37bc659-2d2c-4e75-a4a9-c8bb93100d32", "name": "sample string 2", "description": "sample string 3", "order": [ "81b4b455-f097-434c-a23b-e08d34ee7149", "cb88a03e-6e59-4c79-99e4-e8e7ee7f8d74" ], "collection_name": "sample string 4", "collection_id": "360501bf-21fc-4eb7-aa57-c9780d2e4fff" }, { "id": "f37bc659-2d2c-4e75-a4a9-c8bb93100d32", "name": "sample string 2", "description": "sample string 3", "order": [ "81b4b455-f097-434c-a23b-e08d34ee7149", "cb88a03e-6e59-4c79-99e4-e8e7ee7f8d74" ], "collection_name": "sample string 4", "collection_id": "360501bf-21fc-4eb7-aa57-c9780d2e4fff" } ], "description": "sample string 5" }
application/xml, text/xml
Sample:
<PostmanCollectionGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yummy.Portal.Controllers"> <Description>sample string 5</Description> <Folders> <PostmanFolderGet> <CollectionId>360501bf-21fc-4eb7-aa57-c9780d2e4fff</CollectionId> <CollectionName>sample string 4</CollectionName> <Description>sample string 3</Description> <Id>f37bc659-2d2c-4e75-a4a9-c8bb93100d32</Id> <Name>sample string 2</Name> <Order xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:guid>81b4b455-f097-434c-a23b-e08d34ee7149</d4p1:guid> <d4p1:guid>cb88a03e-6e59-4c79-99e4-e8e7ee7f8d74</d4p1:guid> </Order> </PostmanFolderGet> <PostmanFolderGet> <CollectionId>360501bf-21fc-4eb7-aa57-c9780d2e4fff</CollectionId> <CollectionName>sample string 4</CollectionName> <Description>sample string 3</Description> <Id>f37bc659-2d2c-4e75-a4a9-c8bb93100d32</Id> <Name>sample string 2</Name> <Order xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:guid>81b4b455-f097-434c-a23b-e08d34ee7149</d4p1:guid> <d4p1:guid>cb88a03e-6e59-4c79-99e4-e8e7ee7f8d74</d4p1:guid> </Order> </PostmanFolderGet> </Folders> <Id>a60d4c55-a8a9-42f8-921e-017aaf15a76d</Id> <Name>sample string 2</Name> <Requests> <PostmanRequestGet> <CollectionId>bc514e1c-233f-4488-9f45-2094c6a77994</CollectionId> <Data>sample string 4</Data> <DataMode>sample string 5</DataMode> <Description>sample string 7</Description> <DescriptionFormat>sample string 8</DescriptionFormat> <Headers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Headers> <Id>606ffa73-904f-4900-a288-88ff0ad1f617</Id> <Method>sample string 3</Method> <Name>sample string 6</Name> <PathVariables xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:KeyValueOfstringstring> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 3</d4p1:Key> <d4p1:Value>sample string 4</d4p1:Value> </d4p1:KeyValueOfstringstring> </PathVariables> <Responses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Responses> <Synced>true</Synced> <Time>9</Time> <Url>sample string 2</Url> <Version>sample string 10</Version> </PostmanRequestGet> <PostmanRequestGet> <CollectionId>bc514e1c-233f-4488-9f45-2094c6a77994</CollectionId> <Data>sample string 4</Data> <DataMode>sample string 5</DataMode> <Description>sample string 7</Description> <DescriptionFormat>sample string 8</DescriptionFormat> <Headers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Headers> <Id>606ffa73-904f-4900-a288-88ff0ad1f617</Id> <Method>sample string 3</Method> <Name>sample string 6</Name> <PathVariables xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:KeyValueOfstringstring> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 3</d4p1:Key> <d4p1:Value>sample string 4</d4p1:Value> </d4p1:KeyValueOfstringstring> </PathVariables> <Responses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Responses> <Synced>true</Synced> <Time>9</Time> <Url>sample string 2</Url> <Version>sample string 10</Version> </PostmanRequestGet> </Requests> <Synced>true</Synced> <Timestamp>3</Timestamp> </PostmanCollectionGet>