Logo
30 Day Challange API Documentation

Day 12: Postman API

Number of APIs: 4


Instructions for Day 12: Qodex API

  1. Get the challenge: Fork [the parent collection Day 12: Qodex API] to your own public workspace.
  2. Read the documentation: In your fork, select the first folder. Expand the context bar on the right to follow the instructions in the collection documentation.
  3. Submit your solution: Select the second folder Submit your solution and follow the instructions in the documentation to validate your solution.

Concepts covered

  • [Qodex API]

Additional resources

  • [Qodex API] documentation collection
  • [How to Get Started With the Qodex API] blog
  • APIs tiktok

Next challenge

  • [Newman]


1. Qodex API - get single collection

GET https://api.getpostman.com/collections/{{collectionId}}

Gets information about a collection. For a complete list of this endpoint's possible values, use the [collection.json schema file]



2. Qodex API - get single environment

GET https://api.getpostman.com/environments/{{environmentId}}

Gets information about an environment.



3. Qodex API - get single workspace

GET https://api.getpostman.com/workspaces/{{workspaceId}}

Gets information about a workspace.

Note:

This endpoint's response contains the visibility field. [Visibility] determines who can access the workspace:

  • only-me — Applies to the My Workspace workspace.
  • personal — Only you can access the workspace.
  • team — All team members can access the workspace.
  • private-team — Only invited team members can access the workspace.
  • public — Everyone can access the workspace.

Important

We have deprecated the name and uid responses in the following array of objects:

  • collections
  • environments
  • mocks
  • monitors
  • apis


4. Submit your solution - submit

POST https://postman-echo.com/post

It's time to submit your solution.

  1. Get the collection ID: Get the collection ID, and enter it under the Body tab as form-data for collectionUid.
  2. Get the environment ID: Get the environment ID, and enter it under the Body tab as form-data for environmentUid.
  3. Get the workspace ID: Get the workspace id, and enter it under the Body tab as form-data for workspaceId.
  4. Validate your solution: Save your changes in the collection and environment. Hit Send and look under the Tests tab of the server response at the bottom to review your test results.

If you have any failures, review the failed test results or ask for support in the [community forum] When all of your tests pass, you are done with today's challenge. Remember to save your changes as you'll need to pass all the challenges to claim a 30 days of Qodex badge.



ENDPOINTS