15_Days_of_Postman_-_for_testers_IvanKo API Documentation
Get schema files
GET {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}/files
Gets the files in an API schema. You can use the Note: The versionId query parameter to get schema files published in an API version.versionId query parameter is a required parameter for API viewers.
Body
PARAM
| Key | Datatype | Required | Description |
limit
|
string | The maximum number of rows to return in the response. This value defaults to `10`. | |
versionId
|
string | The API's version ID. | |
cursor
|
string | The pointer to the first record of the set of paginated results. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"meta": {
"nextCursor": "eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJOZXdQZXQuanNvbiJ9"
},
"files": [
{
"id": "e8a015e0-f472-4bb3-a523-57ce7c4583ed",
"path": "data-model/error.yaml",
"name": "error.yaml",
"createdAt": "2022-03-29T11:37:15Z",
"updatedAt": "2022-03-29T11:37:15Z",
"createdBy": 2345,
"updatedBy": 2345
},
{
"id": "e8a015e0-f472-4bb3-a523-57ce7c4583ef",
"path": "data-model/error2.yaml",
"name": "error2.yaml",
"createdAt": "2022-03-29T11:37:15Z",
"updatedAt": "2022-03-29T11:37:15Z",
"createdBy": 2345,
"updatedBy": 2345
}
]
} |
Curl
curl -X GET 'https://api.getpostman.com/apis/apiId/schemas/schemaId/files?limit=<integer>&versionId=<string>&cursor=<string>' -H 'Accept: application/vnd.api.v10+json'
ENDPOINTS