Get schema file contents

Deprecated

GET

/apis/:apiId/schemas/:schemaId/files/:file-path

GET

/apis/:apiId/schemas/:schemaId/files/:file-path

$ curl https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/schemas/5381f010-c4c1-11ed-afa1-0242ac120002/files/postman%2Fcollection%2Fc1.json \
>      -H "Accept: application/vnd.api.v10+json" \
>      -H "x-api-key: <apiKey>"

1 {
2   "id": "0784657a-668d-4530-85c8-468becdb06fd",
3   "name": "Test.json",
4   "path": "common/Test.json",
5   "content": "openapi: '3.0.0'\ninfo:\n  version: '1.0.0'\n  title: 'Sample API'\n  description: Buy or rent spacecrafts\n\npaths:\n  /spacecrafts/{spacecraftId}:\n    parameters:\n      - name: spacecraftId\n        description: The unique identifier of the spacecraft\n        in: path\n        required: true\n        schema:\n          $ref: '#/components/schemas/SpacecraftId'\n    get:\n      summary: Read a spacecraft\n      responses:\n        '200':\n          description: The spacecraft corresponding to the provided `spacecraftId`\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Spacecraft'\n        404:\n          description: No spacecraft found for the provided `spacecraftId`\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\n        500:\n          description: Unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\ncomponents:\n  schemas:\n    SpacecraftId:\n      description: The unique identifier of a spacecraft\n      type: string\n    Spacecraft:\n      type: object\n      required:\n        - id\n        - names\n        - type\n      properties:\n        id:\n          $ref: '#/components/schemas/SpacecraftId'\n        name:\n          type: string\n        type:\n          type: string\n          enum:\n            - capsule\n            - probe\n            - satellite\n            - spaceplane\n            - station\n        description:\n          type: string\n    Error:\n      type: object\n      required:\n        - message\n      properties:\n        message:\n          description: A human readable error message\n          type: string\n  securitySchemes:\n    ApiKey:\n      type: apiKey\n      in: header\n      name: X-Api-Key\nsecurity:\n  - ApiKey: []",
6   "createdAt": "2023-03-15T13:27:45.000Z",
7   "createdBy": "12345678",
8   "updatedAt": "2023-03-15T13:27:45.000Z",
9   "updatedBy": "12345678"
10 }

Gets an API schema file contents at the defined path. You can use the versionId query parameter to get schema file contents published in an API version.

Note:

The versionId query parameter is a required parameter for API viewers.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiIdstringRequired

The API's ID.

schemaIdstringRequired

The API schema's ID.

file-pathstringRequired

The path to the schema file.

Headers

AcceptenumRequired

The application/vnd.api.v10+json request header required to use the endpoint.

Allowed values:

Query parameters

versionIdstringOptional

The API's version ID. This is a required parameter for API viewers.

Response

Successful Response

idstring

The schema file's ID.

namestring

The schema file's name.

pathstring

The file system path to the schema file.

contentstring

The schema file's stringified contents.

createdAtdatetime

The date and time at which the file was created.

createdBystring

The user Id of the user that created the file.

updatedAtdatetime

The date and time at which the file was last updated.

updatedBystring

The user ID of the user that last updated the file.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error