---
title: "Screen an injection on a planning case"
method: POST
path: "/api/v1/project-rooms/{id}/files/{fileId}/study"
tags: ["Projects"]
---

# Screen an injection on a planning case

`POST /api/v1/project-rooms/{id}/files/{fileId}/study`

## Request

- Base URL: `https://askthegrid.com`
- URL: `https://askthegrid.com/api/v1/project-rooms/{id}/files/{fileId}/study`
- Auth: HTTP bearer

A DC screen of the MW a bus can inject (or withdraw) before a circuit reaches its rating, with every outage studied: the ISO's named contingencies when the project has its list, else single circuits. Studies the project's POI when `bus` is omitted. Nothing is saved.

## Path parameters

- `id` string, required
- `fileId` string, required

## Request body

- object
  - `bus` string
  - `mw` number
  - `direction` 'inject' | 'withdraw'
  - `sink` 'load' | 'swing'
  - `ratingBasis` 'rate-a' | 'monitored'
  - `outages` 'project' | 'single'

## Response `200`

Success

- object
  - `study` object, required
    - `version` integer, required
    - `poi` string, required
    - `mw` number, required
    - `direction` 'inject' | 'withdraw', required
    - `limitMw` number, nullable, required
    - `baseLimitMw` number, nullable, required
    - `limitingElement` string, nullable, required
    - `contingency` string, nullable, required
    - `outages` 'named' | 'single', required
    - `ratingBasis` 'rate-a' | 'monitored', required
    - `outagesStudied` integer, required
    - `existingOverloads` integer, required
    - `tightest` object[], required
      - `element` string, required
      - `headroomMw` number, nullable, required
      - `loadingPercent` number, required
      - `contingency` string, nullable, required
    - `limits` string, required

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)
