openapi: 3.2.0
info:
title: General Administration Services API
x-refined-note:
- x-logo differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged Services across 2 of this provider''s published API definitions: general-services-administration-it-collect-openapi.json, general-services-administration-touchpoints-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
description: ''
- url: https://api.gsa.gov/analytics/touchpoints/v1
description: The production Touchpoints API
tags:
- name: Services
paths:
/v1/services:
parameters: []
get:
operationId: getServicesCollection
tags:
- Services
responses:
'200':
description: Services collection
content:
application/ld+json:
schema:
type: array
items:
$ref: '#/components/schemas/Services-read_supService'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Services-read_supService'
'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 Services resources
description: Retrieves the collection of Services resources.
parameters:
- name: agency
in: query
description: Three digit agency code
required: false
deprecated: false
allowEmptyValue: false
schema:
type: string
enum:
- '006'
- '007'
- 009
- '010'
- '011'
- '012'
- '014'
- '015'
- '016'
- 018
- 019
- '020'
- '021'
- '023'
- '024'
- '025'
- '026'
- '027'
- 028
- 029
- '100'
- '184'
- '202'
- '393'
- '422'
- '429'
style: form
explode: false
allowReserved: false
- name: currentUII
in: query
description: Filter for the currentUII of an existing investment
required: false
deprecated: false
allowEmptyValue: false
schema:
type: exact
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: itemsPerPage
in: query
description: The number of items per page
required: false
deprecated: false
allowEmptyValue: true
schema:
type: integer
default: 100
minimum: 0
style: form
explode: false
allowReserved: false
- name: isRetired
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: boolean
style: form
explode: false
allowReserved: false
- name: sort[lastModified]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
enum:
- asc
- desc
style: form
explode: false
allowReserved: false
- name: agency[]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
- name: currentUII[]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
deprecated: false
servers:
- url: /
description: ''
/v1/services/{agencyId}:
parameters: []
get:
operationId: getServicesItem
tags:
- Services
responses:
'200':
description: Services resource
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Services-readItem_readItemSubRes_supService'
application/json:
schema:
$ref: '#/components/schemas/Services-readItem_readItemSubRes_supService'
'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 Services resource
description: Retrieves a Services resource.
parameters:
- name: isRetired
in: query
description: isRetired.
required: false
deprecated: false
allowEmptyValue: false
schema:
type: bool
enum:
- true
- false
style: form
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
servers:
- url: /
description: ''
/service_providers:
get:
summary: List service providers
description: Returns a list of service providers registered in Touchpoints.
tags:
- Services
security:
- api_key: []
responses:
'200':
description: successful
content:
application/json:
example:
value:
data:
- id: '1'
type: service_providers
attributes:
organization_id: 1
organization_abbreviation: GSA
organization_name: General Service Administration
name: Public Experience Portfolio
slug: gsa-usagov
year_designated: 2022
description: The Public Experience Portfolio strives to unify, improve, and standardize the experience the public has interacting with the Federal government. The Public Experience Portfolio operates USAGov, a program that connects people with government information more than 113 million times a year through websites (USA.gov and USAGov en español), social media, email, and phone calls and chats to the USAGov Contact Center.
notes: ''
department: gsa
department_abbreviation: gsa
bureau: Public Experience Portfolio
inactive: false
url: null
new: false
portfolio_manager_email: jane.smith@gsa.gov
service_provider_managers: []
services_count: 1
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ServiceProviderResource'
operationId: getServiceProviders
x-operation-id-source: derived
servers:
- url: https://api.gsa.gov/analytics/touchpoints/v1
description: The production Touchpoints API
/services:
get:
summary: List services
description: Returns a list of services registered in Touchpoints.
tags:
- Services
security:
- api_key: []
parameters:
- name: hisp
in: query
required: false
description: If set to 1, returns only HISP services. If not set or set to 0, returns all services.
schema:
type: integer
responses:
'200':
description: successful
content:
application/json:
example:
value:
data:
- id: '1'
type: services
attributes:
name: Navigating information and tasks during critical life experiences
description: Many users interact with government when they are experiencing a significant life event – such as the birth of a child, marriage or divorce, financial hardship or the loss of a loved one – and frequently, these experiences lead them across Federal agencies in a disconnected journey of discrete tasks. Because USAGov already provides content on common tasks and are not affiliated with any particular agency, USAGov is ideally positioned as a navigational aid for these users.
organization_id: 1
organization_abbreviation: GSA
organization_name: General Service Administration
service_provider_id: 1
service_provider_name: Public Experience Portfolio
service_provider_slug: gsa-usagov
short_description: ''
year_designated: null
previously_reported: false
contact_center: true
kind:
- Informational
transactional: false
notes: ''
hisp: true
service_slug: gsa-usagov
service_owner_email: john.smith@gsa.gov
service_managers:
- email: john.smith@gsa.gov
first_name: John
last_name: Smith
position_title: Service Delivery Manager
profile_photo: null
url: https://www.usa.gov/life-events
homepage_url: https://www.usa.gov/
channels: []
tags: []
available_in_person: false
available_digitally: false
available_via_phone: false
aasm_state: verified
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ServiceResource'
operationId: getServices
x-operation-id-source: derived
servers:
- url: https://api.gsa.gov/analytics/touchpoints/v1
description: The production Touchpoints API
/services/{id}:
get:
summary: Show service
description: Returns details for the given service.
tags:
- Services
security:
- api_key: []
parameters:
- name: id
in: path
description: ID of the service
required: true
schema:
type: integer
responses:
'200':
description: successful
content:
application/json:
example:
value:
data:
id: '1'
type: services
attributes:
name: Navigating information and tasks during critical life experiences
description: Many users interact with government when they are experiencing a significant life event – such as the birth of a child, marriage or divorce, financial hardship or the loss of a loved one – and frequently, these experiences lead them across Federal agencies in a disconnected journey of discrete tasks. Because USAGov already provides content on common tasks and are not affiliated with any particular agency, USAGov is ideally positioned as a navigational aid for these users.
organization_id: 1
organization_abbreviation: GSA
organization_name: General Service Administration
service_provider_id: 1
service_provider_name: Public Experience Portfolio
service_provider_slug: gsa-usagov
short_description: ''
year_designated: null
previously_reported: false
contact_center: true
kind:
- Informational
transactional: false
notes: ''
hisp: true
service_slug: gsa-usagov
service_owner_email: john.smith@gsa.gov
service_managers:
- email: john.smith@gsa.gov
first_name: John
last_name: Smith
position_title: Service Delivery Manager
profile_photo: null
url: https://www.usa.gov/life-events
homepage_url: https://www.usa.gov/
channels: []
tags: []
available_in_person: false
available_digitally: false
available_via_phone: false
aasm_state: verified
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/ServiceResource'
operationId: getServicesById
x-operation-id-source: derived
servers:
- url: https://api.gsa.gov/analytics/touchpoints/v1
description: The production Touchpoints API
components:
schemas:
CioRating-readItem_readItemSubRes_supService:
type: object
description: ''
properties:
agencyId:
description: A unique identifier for the document provided by the submitting user.
type: string
rating:
type: number
format: integer
example: 5
minimum: 1
maximum: 5
description: 'CIOs best judgment of the current level of risk for the Investment in terms of its ability
to accomplish its goals (per 40 U.S.C. § 11315 (c)(2)).
1 represents the lowest possible score and 5 represent the highest possible score.'
comment:
type: string
format: string
example: CIO Evaluation Report on 10/1/2020 produced a score of 5.
description: Explanation and/or additional details regarding this reported value
date:
type: date
format: string
example: '2020-10-01'
description: Provide the date of CIO Evaluation
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
Services-readItem_readItemSubRes_supService:
type: object
description: ''
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: 32
description: A unique identifier for the document provided by the submitting user.
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.'
agency:
type: string
format: numeric
enum:
- '005'
- '006'
- '007'
- 009
- '010'
- '011'
- '012'
- '014'
- '015'
- '016'
- 018
- 019
- '020'
- '021'
- '023'
- '024'
- '025'
- '026'
- '027'
- 028
- 029
- '100'
- '184'
- '202'
- '393'
- '422'
- '429'
example: 018
description: The three digit agency code.
title:
type: string
format: string
example: IT Collect Development
description: 'This is a text field to provide the Investment title. To the extent that they are not
part of the name used by the Agency, other identifiers such as bureaus or other
numeric codes should not be included as part of an Investment title.'
description:
type: string
format: string
example: Sample description of the IT Dashboard modernization process.
description: 'Description for each Investment. This description should briefly explain the
purpose of the Investment and what program(s) it supports, including the value
to the public.'
changeInStatus:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
- 09
- '10'
- '11'
example: '11'
description: 'This is used when an Investment has a change in status (e.g., downgraded to non-major IT Investment,
eliminated, retired, consolidated, split) for the current budget submission relative to the previous budget
cycle. The change of status should be indicated with one of the following reasons:
- 01: Upgraded from non-major to major IT Investment
- 02: Downgraded from major to non-major IT Investment
- 03: Split into multiple Investments
- 04: Consolidation of Investments
- 05: Reorganization
- 06: Eliminated by funding
- 07: Eliminated by split
- 08: Eliminated by consolidation
- 09: Eliminated by reorganization
- 10: New
- 11: No Change in Status'
changeInStatusDescription:
type:
- string
- 'null'
format: string
example: New Service
description: 'This is used when an indicator has been chosen for "Change in Investment Status Identifier" in
order to provide a description of the rationale for the change, which may include impacted UIIs, specific
references to legislative requirements, or governance board decisions and effective dates.'
previousUIIs:
type:
- array
- 'null'
example:
- 018-000001234
description: 'Previous UIIs
Enter an identifier depicting Agency Code and unique investment number
used to report the Investment in the previous BY 2022 Agency IT Portfolio
Summary submission to OMB Array of UIIs must correspond with either active
or formerly active UIIs in IT Collect. All Investments where Change in
Status does not equal “new” must provide Previous UII data.'
items:
type: string
sharedServiceCode:
type: digit
format: string
enum:
- '00'
- '24'
- '48'
example: '00'
description: 'Shared Services Code, 2 digit - 00, 24, or 48
- 00: Code for all Investments other than those coded “24” or “48.”
- 24: E-Gov initiatives or an individual Agency''s participation in one of the EGov/LoB initiatives listed in
Appendix B.
- 48: Any Multi-Agency (Inter- or Intra-Agency) IT collaboration or an individual Agency’s participation
in one of these initiatives, such as use of a centralized FOIA portal.'
sharedServiceId:
type:
- digit
- 'null'
format: string
example: '0024'
minLength: 1
maxLength: 4
description: 'Shared Services Identifier - 4 digits
These four digits are applicable for all Investments with a Shared Services Category of 24 or 48. A code will be
specifically assigned for all E-Gov/LoB shared services in Appendix B, while Agencies should assign their own
four digit unique codes for Multi-Agency initiatives using the “48” shared services category.
This code represents the same 4-digit identifier previously provided in the last nine digits of the UII for
Investments starting with xxx-99999XXXX.'
missionSupportCategories:
type:
- array
- 'null'
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
- 09
- ''
example:
- '01'
externalDocs:
url: https://ussm.gsa.gov/fibf/
description: 'Mission Support Category - 2 digit code - 01, 02, 03, 04, 05, 06, 07, 08, or 09
These two digits indicate the category of common Mission Support Services
Investments by Federal Integrated Business Framework (FIBF) Service Area(s).
All non-Mission Support Services Investments should use Category 01. Mission
Support Services Investments may select more than one code where applicable:
- 01: Not Applicable
- 02: Financial Management
- 03: Human Resources
- 04: Procurement
- 05: Travel / Transportation
- 06: Grants Management
- 07: Electronic Records Management
- 08: Cybersecurity Services
- 09: Other'
items:
type: string
bureauCode:
type: string
format: number
example: '00'
minLength: '2'
maxLength: '2'
description: 'Bureau Code (string) - 2 digit code
The two digits indicate the bureau code of the Investment (see Appendix C of OMB Circular No. A-11).
If this is a department-level or an Agency-wide activity, use “00” as your bureau code.'
partOfAITPS:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
example: '01'
description: 'Part of AITPS (string) - 2 digit code - 01, 02, or 03
These two digits indicate one of the three parts of the Agency IT Portfolio
Summary, to which the Investment belongs:
- 01: Part 1. IT Investments for Mission Delivery
- 02: Part 2. IT Investments for Mission Support Services
- 03: Part 3. IT Investments for IT Infrastructure, IT Security, and IT Management'
standardIdCategory:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
- 09
- '10'
example: '01'
description: 'Standard IT Infrastructure and Management Category
2 digit code - 01, 02, 03, 04, 05, 06, 07 ,08, 09, or 10
These two digits indicate the sub-category of Investments identified as Part 3:
IT Investments for IT Infrastructure, IT Security, and IT Management. For the
FY 2021 reporting cycle, the four previous optional Standard Investments
Output, Application, Delivery, and Platform will now be required.
All Part 3 Investments should select one of the following codes other than “01: Not
Applicable,” while all Part 1 and 2 Investments should select “01: Not Applicable.”
- 01: Not Applicable
- 02: IT Security and Compliance
- 03: IT Management
- 04: Network
- 05: Data Center and Cloud
- 06: End User
- 07: Output
- 08: Application
- 09: Delivery
- 10: Platform'
missionSupportArea:
type:
- string
- 'null'
format: numeric
example: '00'
minLength: 2
maxLength: 2
description: 'Mission Delivery and Management Support Area - 2 digit code
These two digits indicate the mission delivery and management support areas.
Agencies should assign a unique code for each mission delivery and
management support area reported.'
investmentType:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
example: '01'
description: 'Type of Investment - 2 digit code - 01, 02, 03, 04, or 05
These two digits indicate the type of Investment being reported as follows:
- 01: Major IT Investments
- 02: Non-major IT Investments
- 03: IT Migration Investment: The portion of a larger asset and for which there is an existing Business Case
for the overall asset. The description of the IT Investment should indicate the UII of the major asset Investment
of the managing partner.
- 04: Funding Transfer Investments: These are primarily used to indicate the partner contribution to a Lead
Agency Investment through inter- or intraAgency transfers. The description of the IT Investment should indicate
the UII of the Lead Agency’s Investment.
- 05: Standard IT Infrastructure Investments in Part 3: IT Infrastructure, IT Security, IT Management
Investments (IT Security and Compliance, IT Management, Network, Data Center and Cloud, End User, Output,
Application, Delivery, and Platform).'
returnOnInvestment:
type:
- string
- 'null'
format: string
example: Sample description of a return on an investment.
description: '- Return on investment'
nssId:
type: string
format: numeric
enum:
- '01'
- '02'
example: '01'
description: 'National Security Systems Identifier - 2 digit code - 01 or 02
These two digits indicate whether the Investment is a National Security System the Federal Information Security
Management Act of 2002 (FISMA), 44 U.S.C. 3542(b)(2) as follows:
- 01: Non-National Security System Investment
- 02: National Security System Investment (these investments will not be publicly viewable on the IT Dashboard)'
publicUrls:
type:
- array
- 'null'
example:
- https://example.gov
description: 'Public URL(s) List any website or digital service that is supported primarily by this Investment.
Supply an array of strings (URLS).'
items:
type: string
timePeriodId:
type: string
format: string
example: ''
lastModifiedTimePeriod:
type: string
format: string
example: ''
lastModifiedBudgetYear:
type: integer
format: string
example: ''
createdTimePeriod:
type: string
format: string
example: ''
retiredTimePeriod:
type:
- string
- 'null'
format: string
example: ''
rebaseLines:
type: array
readOnly: true
description: A list of associated rebaseLine IDs
items:
type: string
projects:
description: Embed Project Objects
type: array
items:
$ref: '#/components/schemas/Projects-readItem_readItemSubRes_supService'
cioRatings:
description: Embedded CIO Ratings
type: array
items:
$ref: '#/components/schemas/CioRating-readItem_readItemSubRes_supService'
ledgers:
type: array
items:
$ref: '#/components/schemas/Ledger-readItem_readItemSubRes_supService'
contracts:
description: Contract Embedded CONTRACTS
type: array
items:
$ref: '#/components/schemas/Contract-readItem_readItemSubRes_supService'
metrics:
description: Metrics. Referenced Metric Documents--not embedded
type: array
items:
$ref: '#/components/schemas/Metric-readItem_readItemSubRes_supService'
operationalAnalysis:
description: Embedded OperationalAnalysis
type: array
items:
$ref: '#/components/schemas/OperationalAnalysis-readItem_readItemSubRes_supService'
Metric-readItem_readItemSubRes_supService:
type: object
description: ''
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: 32
description: Enter a required Unique ID provided by Agency for the metric
serviceAgencyId:
type: string
example: Service22304
description: Enter the Service ID of the investment that this performance metric applies to here
agency:
type: string
format: numeric
enum:
- '005'
- '006'
- '007'
- 009
- '010'
- '011'
- '012'
- '014'
- '015'
- '016'
- 018
- 019
- '020'
- '021'
- '023'
- '024'
- '025'
- '026'
- '027'
- 028
- 029
- '100'
- '184'
- '202'
- '393'
- '422'
- '429'
example: 018
description: The three digit agency code.
actual:
description: '* @var ArrayCollection Embedded MetricActual Objects'
type: array
items:
$ref: '#/components/schemas/MetricActual-readItem_readItemSubRes_supService'
rebaseLines:
type: array
example:
- 018git -000001234
readOnly: true
description: A list of associated rebaseLine IDs
items:
type: string
isRetired:
type: bool
example: false
description: Set this value to true when this performance metrics is no longer useful for investment management.
OperationalAnalysis-readItem_readItemSubRes_supService:
type: object
description: ''
properties:
agencyId:
type: string
format: alphanumeric
minLength: 1
maxLength: 64
description: A unique identifier for the document provided by the submitting user.
date:
type: string
format: date
example: '2020-08-15'
description: The date [YYYY-MM-DD] that the operational analysis is submitted
analysisResults:
type: string
format: string
example: Sample description of the analysis results
description: The results of the operational analysis
analysisConclusion:
type: string
enum:
- continue as-is
- initiate remediation action
- initiate innovation action
- initiate modernization/replacement action
- initiate disposal action
example: continue as-is
description: The conclusion of the operational analysis
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
required:
- date
- analysisResults
Projects-readItem_readItemSubRes_supService:
type: object
description: ''
properties:
agencyId:
type: string
format: alphanumeric
minLength: 1
maxLength: 64
description: A unique identifier for the document provided by the submitting user.
projectId:
type: string
format: string
example: GSAProj1
description: An Agency-specified alphanumeric code that uniquely identifies the project within the Investment.
projectName:
type: string
format: string
example: API Submissions Development
maxLength: 100
description: Name used by the Agency to refer specifically to the project.
projectGoal:
type: string
format: string
example: Develop a mechanism to collect CPIC data
maxLength: 250
description: 'Brief description of primary goal/outcome the project is planning to provide for the Investment
upon completion. This field is masked from public view.'
plannedStartDate:
type:
- string
- 'null'
format: date
example: '2020-08-15'
description: 'Enter the planned start date [YYYY-MM-DD] of this project.
Modifying this field via PUT or PATCH operation will require a rebaseline'
projectedStartDate:
type:
- string
- 'null'
format: date
example: '2020-08-15'
description: Enter the projected start date [YYYY-MM-DD] of this project.
actualStartDate:
type:
- string
- 'null'
format: date
example: '2020-08-15'
description: Enter the actual start date [YYYY-MM-DD] of this project.
plannedEndDate:
type:
- string
- 'null'
format: date
example: '2020-11-20'
description: 'Enter the planned end date [YYYY-MM-DD] of this project.
Modifying this field via PUT or PATCH operation will require a rebaseline.'
projectedEndDate:
type:
- string
- 'null'
format: date
example: '2020-11-20'
description: Enter the projected end date [YYYY-MM-DD] of this project.
actualEndDate:
type:
- string
- 'null'
format: date
example: '2020-11-20'
description: Enter the actual end date [YYYY-MM-DD] of this project.
plannedTotalCost:
type:
- number
- 'null'
format: decimal
example: 100
description: 'Enter the planned total cost of this project in millions.
[$mm] Modifying this field via PUT or PATCH operation will require a rebaseline.'
projectedTotalCost:
type:
- number
- 'null'
format: decimal
example: 100
description: Enter the projected total cost of this project in millions. [$mm]
actualTotalCost:
type:
- number
- 'null'
format: float
example: 1100
description: Enter the actual total cost of this project in millions. [$mm]
softwareProject:
type:
- bool
- 'null'
example: false
description: 'Enter whether this project is developing or deploying software solutions
as a primary focus of this project.'
tmfInitiative:
type: string
format: string
example: ''
description: Enter a valid and existing tmfInitiative from the TMF Initiatives collection.
rebaseLines:
type: array
readOnly: true
description: A list of associated rebaseLine IDs
items:
type: string
iterationFrequencyUnits:
type:
- string
- 'null'
enum:
- Days
- Weeks
- Months
- Years
example: Weeks
description: Select the frequency of incremental development release iterations units
isMasked:
type: bool
example: true
description: A readonly boolean indicating whether the document is masked from the public.
default: true
costVariance:
type: float
format: float
example: '0.0'
description: Project Variance Score.
costVarianceMonetaryAmount:
type: float
format: float
example: '0.0'
description: The Dollar amount for costVariance (numerator in costVariance calculation).
scheduleVariance:
type: float
format: float
example: '0.0'
description: Schedule Variance Score.
scheduleVarianceDayAmount:
type: int
format: int
example: 0
description: Schedule Variance Day amount (numerator in schedule variance score calculation).
projectStatus:
type:
- string
- 'null'
enum:
- Not Started
- In Progress
- Completed
- Deferred
- Canceled
example: In Progress
description: Enter the project's current status
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
MetricActual-readItem_readItemSubRes_supService:
type: object
description: ''
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
Contract-readItem_readItemSubRes_supService:
type: object
description: ''
properties:
agencyId:
type: string
format: alphanumeric
minLength: 1
maxLength: 64
description: A unique identifier for the document provided by the submitting user.
PIID:
type: string
format: string
example: IT-00-000-00
description: 'The unique identifier for each contract, agreement, or order associated with this
Investment (Federal Procurement Data Systems (FPDS) data element 1A).
Enter PIID numbers for contacts, agreements, or orders both that have already been awarded.
Completed and/or expired contracts do not need to be included.
Data definitions can be found at Federal Procurement Data System.
Please note that reference PIIDs should not be entered for this field.'
referencePIID:
type:
- string
- 'null'
format: string
example: IT-123-000
description: 'For each PIID number reported for contract support obtained via an order or call,
report the Reference PIID per FPDS instructions for element 1c.'
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
Ledger-readItem_readItemSubRes_supService:
type: object
description: ''
properties:
agencyId:
description: A unique identifier for the document provided by the submitting user.
type: string
costItem:
type:
- string
- 'null'
example: IT Dashboard Infrastructure Expense
description: 'Optional descriptive name detailing the type of funding information provided within given
ledger item'
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
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.'
costPool:
type:
- string
- 'null'
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
- 'null'
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.'
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'''
ledgerElementStyle:
type: string
enum:
- Funding Sources Only
- TBM Only
- All
- Budget Authority
example: TBM Only
description: 'Indicate the type of funding data a given ledger request will provide to IT Collect. This field''s
selection will trigger a series of validation checks to ensure that Agencies are providing and omitting the
relevant data points for either Funding Sources or TBM reporting. Funding Sources reporting will mandate the
inclusion of the Funding Source, Source, and Type fields. TBM reporting will mandate the inclusion of either
the Cost Pool or IT Tower field. Budget Authority requests must include the same set of fields as Funding
Source request, however, Budget Authority submissions do not count toward the aggregate funding total of an
investment.'
alternateBureau:
type:
- string
- 'null'
format: number
example: '10'
minLength: '2'
maxLength: '2'
description: 'Alternate Bureau (string) - 2 digit code
Enter the Bureau who controls spending for this ledger entry'
rebaseLines:
type: array
readOnly: true
description: A list of associated rebaseLine IDs
items:
type: string
isMasked:
type: bool
example: true
readOnly: true
description: A readonly boolean indicating whether the document is masked from the public.
default: true
isRetired:
type: bool
example: false
description: Boolean indicating if the document has been retired
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
Services-read_supService:
type: object
description: ''
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: 32
description: A unique identifier for the document provided by the submitting user.
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.'
agency:
type: string
format: numeric
enum:
- '005'
- '006'
- '007'
- 009
- '010'
- '011'
- '012'
- '014'
- '015'
- '016'
- 018
- 019
- '020'
- '021'
- '023'
- '024'
- '025'
- '026'
- '027'
- 028
- 029
- '100'
- '184'
- '202'
- '393'
- '422'
- '429'
example: 018
description: The three digit agency code.
title:
type: string
format: string
example: IT Collect Development
description: 'This is a text field to provide the Investment title. To the extent that they are not
part of the name used by the Agency, other identifiers such as bureaus or other
numeric codes should not be included as part of an Investment title.'
description:
type: string
format: string
example: Sample description of the IT Dashboard modernization process.
description: 'Description for each Investment. This description should briefly explain the
purpose of the Investment and what program(s) it supports, including the value
to the public.'
changeInStatus:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
- 09
- '10'
- '11'
example: '11'
description: 'This is used when an Investment has a change in status (e.g., downgraded to non-major IT Investment,
eliminated, retired, consolidated, split) for the current budget submission relative to the previous budget
cycle. The change of status should be indicated with one of the following reasons:
- 01: Upgraded from non-major to major IT Investment
- 02: Downgraded from major to non-major IT Investment
- 03: Split into multiple Investments
- 04: Consolidation of Investments
- 05: Reorganization
- 06: Eliminated by funding
- 07: Eliminated by split
- 08: Eliminated by consolidation
- 09: Eliminated by reorganization
- 10: New
- 11: No Change in Status'
changeInStatusDescription:
type:
- string
- 'null'
format: string
example: New Service
description: 'This is used when an indicator has been chosen for "Change in Investment Status Identifier" in
order to provide a description of the rationale for the change, which may include impacted UIIs, specific
references to legislative requirements, or governance board decisions and effective dates.'
previousUIIs:
type:
- array
- 'null'
example:
- 018-000001234
description: 'Previous UIIs
Enter an identifier depicting Agency Code and unique investment number
used to report the Investment in the previous BY 2022 Agency IT Portfolio
Summary submission to OMB Array of UIIs must correspond with either active
or formerly active UIIs in IT Collect. All Investments where Change in
Status does not equal “new” must provide Previous UII data.'
items:
type: string
sharedServiceCode:
type: digit
format: string
enum:
- '00'
- '24'
- '48'
example: '00'
description: 'Shared Services Code, 2 digit - 00, 24, or 48
- 00: Code for all Investments other than those coded “24” or “48.”
- 24: E-Gov initiatives or an individual Agency''s participation in one of the EGov/LoB initiatives listed in
Appendix B.
- 48: Any Multi-Agency (Inter- or Intra-Agency) IT collaboration or an individual Agency’s participation
in one of these initiatives, such as use of a centralized FOIA portal.'
sharedServiceId:
type:
- digit
- 'null'
format: string
example: '0024'
minLength: 1
maxLength: 4
description: 'Shared Services Identifier - 4 digits
These four digits are applicable for all Investments with a Shared Services Category of 24 or 48. A code will be
specifically assigned for all E-Gov/LoB shared services in Appendix B, while Agencies should assign their own
four digit unique codes for Multi-Agency initiatives using the “48” shared services category.
This code represents the same 4-digit identifier previously provided in the last nine digits of the UII for
Investments starting with xxx-99999XXXX.'
missionSupportCategories:
type:
- array
- 'null'
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
- 09
- ''
example:
- '01'
externalDocs:
url: https://ussm.gsa.gov/fibf/
description: 'Mission Support Category - 2 digit code - 01, 02, 03, 04, 05, 06, 07, 08, or 09
These two digits indicate the category of common Mission Support Services
Investments by Federal Integrated Business Framework (FIBF) Service Area(s).
All non-Mission Support Services Investments should use Category 01. Mission
Support Services Investments may select more than one code where applicable:
- 01: Not Applicable
- 02: Financial Management
- 03: Human Resources
- 04: Procurement
- 05: Travel / Transportation
- 06: Grants Management
- 07: Electronic Records Management
- 08: Cybersecurity Services
- 09: Other'
items:
type: string
bureauCode:
type: string
format: number
example: '00'
minLength: '2'
maxLength: '2'
description: 'Bureau Code (string) - 2 digit code
The two digits indicate the bureau code of the Investment (see Appendix C of OMB Circular No. A-11).
If this is a department-level or an Agency-wide activity, use “00” as your bureau code.'
partOfAITPS:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
example: '01'
description: 'Part of AITPS (string) - 2 digit code - 01, 02, or 03
These two digits indicate one of the three parts of the Agency IT Portfolio
Summary, to which the Investment belongs:
- 01: Part 1. IT Investments for Mission Delivery
- 02: Part 2. IT Investments for Mission Support Services
- 03: Part 3. IT Investments for IT Infrastructure, IT Security, and IT Management'
standardIdCategory:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
- '06'
- '07'
- 08
- 09
- '10'
example: '01'
description: 'Standard IT Infrastructure and Management Category
2 digit code - 01, 02, 03, 04, 05, 06, 07 ,08, 09, or 10
These two digits indicate the sub-category of Investments identified as Part 3:
IT Investments for IT Infrastructure, IT Security, and IT Management. For the
FY 2021 reporting cycle, the four previous optional Standard Investments
Output, Application, Delivery, and Platform will now be required.
All Part 3 Investments should select one of the following codes other than “01: Not
Applicable,” while all Part 1 and 2 Investments should select “01: Not Applicable.”
- 01: Not Applicable
- 02: IT Security and Compliance
- 03: IT Management
- 04: Network
- 05: Data Center and Cloud
- 06: End User
- 07: Output
- 08: Application
- 09: Delivery
- 10: Platform'
missionSupportArea:
type:
- string
- 'null'
format: numeric
example: '00'
minLength: 2
maxLength: 2
description: 'Mission Delivery and Management Support Area - 2 digit code
These two digits indicate the mission delivery and management support areas.
Agencies should assign a unique code for each mission delivery and
management support area reported.'
investmentType:
type: string
format: numeric
enum:
- '01'
- '02'
- '03'
- '04'
- '05'
example: '01'
description: 'Type of Investment - 2 digit code - 01, 02, 03, 04, or 05
These two digits indicate the type of Investment being reported as follows:
- 01: Major IT Investments
- 02: Non-major IT Investments
- 03: IT Migration Investment: The portion of a larger asset and for which there is an existing Business Case
for the overall asset. The description of the IT Investment should indicate the UII of the major asset Investment
of the managing partner.
- 04: Funding Transfer Investments: These are primarily used to indicate the partner contribution to a Lead
Agency Investment through inter- or intraAgency transfers. The description of the IT Investment should indicate
the UII of the Lead Agency’s Investment.
- 05: Standard IT Infrastructure Investments in Part 3: IT Infrastructure, IT Security, IT Management
Investments (IT Security and Compliance, IT Management, Network, Data Center and Cloud, End User, Output,
Application, Delivery, and Platform).'
returnOnInvestment:
type:
- string
- 'null'
format: string
example: Sample description of a return on an investment.
description: '- Return on investment'
nssId:
type: string
format: numeric
enum:
- '01'
- '02'
example: '01'
description: 'National Security Systems Identifier - 2 digit code - 01 or 02
These two digits indicate whether the Investment is a National Security System the Federal Information Security
Management Act of 2002 (FISMA), 44 U.S.C. 3542(b)(2) as follows:
- 01: Non-National Security System Investment
- 02: National Security System Investment (these investments will not be publicly viewable on the IT Dashboard)'
publicUrls:
type:
- array
- 'null'
example:
- https://example.gov
description: 'Public URL(s) List any website or digital service that is supported primarily by this Investment.
Supply an array of strings (URLS).'
items:
type: string
isMasked:
type: bool
example: true
readOnly: true
description: A readonly boolean indicating whether the document is masked from the public.
default: true
isRetired:
type: bool
example: false
description: Boolean indicating if the document has been retired
timePeriodId:
type: string
format: string
example: ''
lastModifiedTimePeriod:
type: string
format: string
example: ''
lastModifiedBudgetYear:
type: integer
format: string
example: ''
createdTimePeriod:
type: string
format: string
example: ''
retiredTimePeriod:
type:
- string
- 'null'
format: string
example: ''
rebaseLines:
type: array
readOnly: true
description: A list of associated rebaseLine IDs
items:
type: string
ServiceProviderResource:
type: object
description: Represents a service provider organization, which may have one or more services associated with it.
required:
- id
- type
- attributes
properties:
id:
type: string
description: Numeric identifier of the service provider (string-encoded).
type:
type: string
enum:
- service_providers
attributes:
$ref: '#/components/schemas/ServiceProviderAttributes'
ServiceChannel:
type: object
required:
- id
- name
- created_at
- updated_at
- taggings_count
properties:
id:
type: integer
description: Numeric identifier of the channel tag.
name:
type: string
description: Machine-readable channel name (e.g. 'email', 'phone', 'computer', 'other_digital').
created_at:
type: string
format: date-time
description: ISO 8601 timestamp when the channel tag was created.
updated_at:
type: string
format: date-time
description: ISO 8601 timestamp when the channel tag was last updated.
taggings_count:
type: integer
description: Number of times this channel tag has been applied across all services.
ServiceProviderAttributes:
type: object
required:
- organization_id
- organization_abbreviation
- organization_name
- name
- slug
- year_designated
- description
- department
- department_abbreviation
- bureau
- inactive
- new
- portfolio_manager_email
- service_provider_managers
- services_count
properties:
organization_id:
type: integer
description: Numeric ID of the parent organization.
organization_abbreviation:
type: string
description: Short acronym of the parent organization.
organization_name:
type: string
description: Full name of the parent organization.
name:
type: string
description: Display name of the service provider.
slug:
type: string
description: URL-safe identifier for the service provider.
year_designated:
type: integer
description: Year the service provider was officially designated.
description:
type: string
description: Long-form description of the service provider's mission and scope.
notes:
type: string
description: Optional freeform notes. May be empty string.
department:
type: string
description: Lowercase department code or label (e.g. 'usda', 'Multi-Agency').
department_abbreviation:
type: string
description: Lowercase department acronym.
bureau:
type: string
description: Name of the bureau within the department.
inactive:
type: boolean
description: Whether the service provider is inactive.
url:
type:
- string
- 'null'
format: uri
description: Public URL for the service provider. Null if not yet assigned.
new:
type: boolean
description: Whether the service provider was recently added.
portfolio_manager_email:
type: string
format: email
description: Email address of the OMB portfolio manager responsible for this provider.
service_provider_managers:
type: array
description: List of agency-side managers for this service provider.
items:
$ref: '#/components/schemas/User'
services_count:
type: integer
description: Number of services associated with this provider.
ServiceResource:
type: object
description: A service record representing a discrete public-facing service offered by a federal agency.
required:
- id
- type
- attributes
properties:
id:
type: string
description: Numeric identifier of the service (string-encoded).
type:
type: string
enum:
- services
attributes:
$ref: '#/components/schemas/ServiceAttributes'
ServiceAttributes:
type: object
required:
- name
- description
- organization_id
- organization_abbreviation
- organization_name
- previously_reported
- contact_center
- kind
- transactional
- hisp
- service_owner_email
- service_managers
- channels
- tags
- available_in_person
- available_digitally
- available_via_phone
- aasm_state
properties:
name:
type: string
description: Display name of the service.
description:
type: string
description: Long-form description of the service.
organization_id:
type: integer
description: Numeric ID of the parent organization.
organization_abbreviation:
type: string
description: Short acronym of the parent organization.
organization_name:
type: string
description: Full name of the parent organization.
service_provider_id:
type:
- integer
- 'null'
description: Numeric ID of the associated service provider. Null if unassigned.
service_provider_name:
type:
- string
- 'null'
description: Display name of the associated service provider. Null if unassigned.
service_provider_slug:
type:
- string
- 'null'
description: URL-safe slug of the associated service provider. Null if unassigned.
short_description:
type: string
description: Brief summary of the service. May be empty string.
year_designated:
type:
- integer
- 'null'
description: Year the service was officially designated. Null if not yet designated.
previously_reported:
type: boolean
description: Whether this service was reported in a prior reporting period.
contact_center:
type: boolean
description: Whether the service operates a contact center.
kind:
type: array
description: One or more service type classifications.
items:
type: string
enum:
- Administrative
- Benefits
- Data and Research
- Informational
- Other
transactional:
type: boolean
description: Whether the service is transactional in nature.
notes:
type: string
description: Internal freeform notes about the service. May be empty string.
hisp:
type: boolean
description: Whether the service is a High Impact Service Provider (HISP) service.
service_slug:
type: string
description: URL-safe slug for the service. May be empty string.
service_owner_email:
type: string
format: email
description: Email address of the service owner.
service_managers:
type: array
description: List of managers responsible for this service.
items:
$ref: '#/components/schemas/User'
url:
type: string
format: uri
description: Direct URL to the service. May be empty string.
homepage_url:
type: string
format: uri
description: Homepage URL for the service. May be empty string.
channels:
type: array
description: Delivery channels through which the service is available.
items:
$ref: '#/components/schemas/ServiceChannel'
tags:
type: array
description: Taxonomy tags associated with the service.
items:
$ref: '#/components/schemas/Tag'
available_in_person:
type: boolean
description: Whether the service is available in person.
available_digitally:
type: boolean
description: Whether the service is available digitally.
available_via_phone:
type: boolean
description: Whether the service is available via phone.
aasm_state:
type: string
description: Current workflow state of the service record.
enum:
- created
- verified
User:
type: object
description: A Touchpoints user account.
required:
- email
properties:
email:
type: string
format: email
description: Work email of the user.
first_name:
type:
- string
- 'null'
description: User's first name. Null if not yet provided.
last_name:
type:
- string
- 'null'
description: User's last name. Null if not yet provided.
position_title:
type:
- string
- 'null'
description: User's job title. Null if not yet provided.
profile_photo:
type:
- string
- 'null'
format: uri
description: URL to the user's profile photo. Null if not uploaded.
Tag:
type: object
required:
- id
- name
- created_at
- updated_at
- taggings_count
properties:
id:
type: integer
description: Numeric identifier of the tag.
name:
type: string
description: Human-readable tag label.
created_at:
type: string
format: date-time
description: ISO 8601 timestamp when the tag was created.
updated_at:
type: string
format: date-time
description: ISO 8601 timestamp when the tag was last updated.
taggings_count:
type: integer
description: Number of times this tag has been applied
securitySchemes:
api_key:
type: apiKey
name: x-api-key
in: header
x-refined-from:
- general-services-administration-it-collect-openapi.json
- general-services-administration-touchpoints-openapi.yaml