openapi: 3.2.0
info:
title: ITCollect Public By 2026 Ledger History Feed 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: LedgerHistoryFeed
paths:
/v1/feeds/ledger-history-feeds:
parameters: []
get:
operationId: getLedgerHistoryFeedCollection
tags:
- LedgerHistoryFeed
responses:
'200':
description: LedgerHistoryFeed collection
content:
application/ld+json:
schema:
type: array
items:
$ref: '#/components/schemas/LedgerHistoryFeed-ledgerHistoryFeed_read'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/LedgerHistoryFeed-ledgerHistoryFeed_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 LedgerHistoryFeed resources
description: Retrieves the collection of LedgerHistoryFeed resources.
parameters:
- name: timePeriodId
in: query
description: TimePeriod ID
required: false
deprecated: false
allowEmptyValue: false
schema:
type: string
style: form
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
- name: timePeriodId[]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
- name: agencyId
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
- name: agencyId[]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
deprecated: false
components:
schemas:
LedgerHistoryFeed-ledgerHistoryFeed_read:
type: object
description: ''
properties:
agencyId:
description: A unique identifier for the document provided by the submitting user.
type: string
timePeriodId:
type: string
currentUII:
type: string
format: string
example: 018-000000123
description: 'The Current UII includes an Agency code and a nine-digit unique identifier.
Variable information formerly included in the UII of previous years is not part
of the UII primary key.'
year:
type: number
format: year
example: 2022
description: A Fiscal year associated with the funding in a given ledger item
amount:
type: number
format: decimal
example: 100
description: Funding amount for a ledger item
costPool:
type: string
enum:
- Internal Labor
- External Labor
- Outside Services
- Hardware
- Software
- Facilities & Power
- Telecom
- Other
- Internal Services
- ''
example: Outside Services
description: 'For ledger items selecting TBM reporting, Agencies can align funding against a Cost Pool per the
definitions for TBM v3.0 provided online by the TBM Council'
ITTower:
type: string
enum:
- End User
- Application
- Delivery
- Security & Compliance
- IT Management
- Data Center
- Network
- Compute
- Storage
- Platform
- Output
- ''
example: Data Center
description: 'For ledger items selecting TBM reporting, Agencies can align funding against a IT Tower per the
definitions for TBM v3.0 provided online by the TBM Council'
fundingSource:
type: string
example: 001-00-9004
description: 'For ledger items selecting Funding Sources Reporting, indicate the Funding Source associated
with a given ledger item.'
type:
type:
- string
- 'null'
enum:
- O&M
- DME
example: O&M
description: 'Select either O&M or DME.
O&M: Operations & Maintenance Costs refers to the expenses
required to operate and maintain an IT asset that is operating in a production environment.
DME: Development,
Modernization, and Enhancement refers to projects and activities leading to new IT assets/systems, as well as
projects and activities that change or modify existing IT assets to substantively improve capability or
performance, implement legislative or regulatory requirements, or meet an Agency leadership request. DME activity
may occur at any time during a program’s life cycle.'
source:
type:
- string
- 'null'
enum:
- Internal Funding
- Contributions
example: Internal Funding
description: 'For ledger items selecting Funding Sources Reporting, indicate whether the funding is associated
with ''Agency Funding'' or ''Contributions'''
isRetired:
type: bool
example: false
description: Boolean indicating if the document has been retired
agency:
readOnly: true
description: The three digit agency code.
type: string