openapi: 3.2.0 info: title: ITCollect Public By 2026 Metric Actual API version: 0.1-beta description: 'The IT Dashboard team aims to build a modern API that acts as the center-piece of a modular IT data reporting ecosystem. This OpenAPI spec shows the initial direction of ITCollect Public data architecture for budget year 2026, and it is aimed at providing real-time updates to the IT Collect Public By 2026 API. It will serve as living documentation of the latest changes. In order to access ITCollect Public Api, Please fill out the below form to obtain an authorization key Loading signup form...' x-logo: url: images/logo-gsa.svg backgroundColor: '#FFFFFF' altText: U.S General Services Administration servers: - url: / description: '' tags: - name: MetricActual paths: /v1/metric/{metric}/metric-actual: parameters: - name: metric in: path description: '' required: true deprecated: false allowEmptyValue: false schema: [] style: simple explode: false allowReserved: false get: operationId: getMetricActualCollection tags: - MetricActual responses: '200': description: MetricActual collection content: application/ld+json: schema: type: array items: $ref: '#/components/schemas/MetricActual-read' application/json: schema: type: array items: $ref: '#/components/schemas/MetricActual-read' '400': description: Bad Request content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/ConstraintViolationList '@type': type: string example: ConstraintViolationList hydra:title: type: string example: Validation Errors Encountered hydra:description: type: string example: Found `2` constraint violations violations: type: array items: - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 1 code: type: string example: 25c84bec-2466-47ba-83d2-3b7243593897 - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 2 code: type: string example: 70bafca1-5975-4171-92cc-e3cdde9b4b7d hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/ConstraintViolationList '@type': type: string example: ConstraintViolationList hydra:title: type: string example: Validation Errors Encountered hydra:description: type: string example: Found `2` constraint violations violations: type: array items: - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 1 code: type: string example: 25c84bec-2466-47ba-83d2-3b7243593897 - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 2 code: type: string example: 70bafca1-5975-4171-92cc-e3cdde9b4b7d hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g '404': description: Resource Not Found content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: NotFoundHttpException hydra:description: type: string example: Not Found hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: NotFoundHttpException hydra:description: type: string example: Not Found hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g '406': description: Unsupported Media Type content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: UnsupportedMediaTypeHttpException hydra:description: type: string example: Unsupported Media Type: The provided content-type is not supported, Supported MIME types are: POST/PUT/DELETE: application/json, or application/ld+json PATCH: application/merge-patch+json GET: application/json, application/ld+json, or text/csv hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: UnsupportedMediaTypeHttpException hydra:description: type: string example: Unsupported Media Type: The provided content-type is not supported, Supported MIME types are: POST/PUT/DELETE: application/json, or application/ld+json PATCH: application/merge-patch+json GET: application/json, application/ld+json, or text/csv hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g '500': description: Internal Server Error content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: InternalServerErrorException hydra:description: type: string example: Internal Server Error hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: InternalServerErrorException hydra:description: type: string example: Internal Server Error hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g summary: Retrieves the collection of MetricActual resources description: Retrieves the collection of MetricActual resources. parameters: - name: metric in: path description: '' required: true deprecated: false allowEmptyValue: false schema: [] style: simple explode: false allowReserved: false - name: page in: query description: The collection page number required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false deprecated: false /v1/metric/{metric}/metric-actual/{agencyId}: parameters: - name: metric in: path description: '' required: true deprecated: false allowEmptyValue: false schema: [] style: simple explode: false allowReserved: false get: operationId: getMetricActualItem tags: - MetricActual responses: '200': description: MetricActual resource content: application/ld+json: schema: $ref: '#/components/schemas/MetricActual-readItem_readItemSubRes' application/json: schema: $ref: '#/components/schemas/MetricActual-readItem_readItemSubRes' '400': description: Bad Request content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/ConstraintViolationList '@type': type: string example: ConstraintViolationList hydra:title: type: string example: Validation Errors Encountered hydra:description: type: string example: Found `2` constraint violations violations: type: array items: - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 1 code: type: string example: 25c84bec-2466-47ba-83d2-3b7243593897 - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 2 code: type: string example: 70bafca1-5975-4171-92cc-e3cdde9b4b7d hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/ConstraintViolationList '@type': type: string example: ConstraintViolationList hydra:title: type: string example: Validation Errors Encountered hydra:description: type: string example: Found `2` constraint violations violations: type: array items: - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 1 code: type: string example: 25c84bec-2466-47ba-83d2-3b7243593897 - type: object properties: propertyPath: type: string example: propertyName message: type: string example: Sample error message 2 code: type: string example: 70bafca1-5975-4171-92cc-e3cdde9b4b7d hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g '404': description: Resource Not Found content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: NotFoundHttpException hydra:description: type: string example: Not Found hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: NotFoundHttpException hydra:description: type: string example: Not Found hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g '406': description: Unsupported Media Type content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: UnsupportedMediaTypeHttpException hydra:description: type: string example: Unsupported Media Type: The provided content-type is not supported, Supported MIME types are: POST/PUT/DELETE: application/json, or application/ld+json PATCH: application/merge-patch+json GET: application/json, application/ld+json, or text/csv hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: UnsupportedMediaTypeHttpException hydra:description: type: string example: Unsupported Media Type: The provided content-type is not supported, Supported MIME types are: POST/PUT/DELETE: application/json, or application/ld+json PATCH: application/merge-patch+json GET: application/json, application/ld+json, or text/csv hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g '500': description: Internal Server Error content: application/ld+json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: InternalServerErrorException hydra:description: type: string example: Internal Server Error hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g application/json: schema: type: object properties: '@context': type: string example: /contexts/Error '@type': type: string example: hydra:Error hydra:title: type: string example: InternalServerErrorException hydra:description: type: string example: Internal Server Error hydra:request_id: type: string example: xzf6bgh6-8ba2-83jn-p5a1-e4ac0f74nf5g summary: Retrieves a MetricActual resource description: Retrieves a MetricActual resource. parameters: - name: metric in: path description: '' required: true deprecated: false allowEmptyValue: false schema: [] style: simple explode: false allowReserved: false - name: agencyId in: path description: Resource identifier required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false components: schemas: MetricActual-read: type: object description: '' additionalProperties: false properties: created: type: string format: timestamp example: '2020-01-01 15:00:00' readOnly: true description: Created date/time lastModified: type: string format: timestamp example: '2020-01-01 15:00:00' readOnly: true description: Last modified date/time agencyCode: type: string format: string example: 018 description: The agency code of the user who created the record agencyId: type: string format: alphanumeric minLength: 1 maxLength: 64 result: type: number format: decimal description: Enter the actual result measured example: 100 date: type: string format: date description: Date of Actual Result Enter the end date of the most recent reporting period example: '2020-09-30' comment: type: string format: string example: September 2020 result description: Provide a comment for results that have not met their target metTarget: type: string formate: string example: MET readOnly: true description: A readonly boolean indicating whether the document is masked from the public. default: N/A rebaseLines: type: array readOnly: true description: A list of associated rebaseLine IDs items: type: string MetricActual-readItem_readItemSubRes: type: object description: '' additionalProperties: false properties: created: type: string format: timestamp example: '2020-01-01 15:00:00' readOnly: true description: Created date/time lastModified: type: string format: timestamp example: '2020-01-01 15:00:00' readOnly: true description: Last modified date/time agencyCode: type: string format: string example: 018 description: The agency code of the user who created the record agencyId: type: string format: alphanumeric minLength: 1 maxLength: 64 result: type: number format: decimal description: Enter the actual result measured example: 100 date: type: string format: date description: Date of Actual Result Enter the end date of the most recent reporting period example: '2020-09-30' comment: type: string format: string example: September 2020 result description: Provide a comment for results that have not met their target metTarget: type: string formate: string example: MET readOnly: true description: A readonly boolean indicating whether the document is masked from the public. default: N/A rebaseLines: type: array readOnly: true description: A list of associated rebaseLine IDs items: type: string