OpenAPI Specification
openapi: 3.0.1
info:
description: APIs to manage and consume information about Carriers
title: Noyo Carrier Carrier Mapped Field Feed API
version: 1.0.0
servers: []
tags:
- name: Feed
paths:
/ui/v1/feeds/{id}/runs:
x-summary: List Feed Runs for Feed
get:
description: Returns a list of feed runs
operationId: uiGetFeedRuns
parameters:
- description: Unique identifier of the feed
in: path
name: id
required: true
schema:
example: 00ffa55b-84e1-48d7-8587-57103c10903f
format: uuid
type: string
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 1
response:
- carrier_transmission:
id: bda1b068-3e6a-4cc3-9769-0fb8a38649ce
sent_timestamp: 1641171601
file:
gcs_path: '''25cbdfbb-97e1-47ee-b482-123994d4d7cd/f035b3cc-7ad1-400f-b069-b958f90632e4.txt'''
includes_phi: true
is_test: true
name: foo
workflow:
created: 1641171601
id: 0ff1e7ef-16f8-42ec-b6d9-330e75d5a1e2
status: completed
schema:
$ref: '#/components/schemas/PaginatedUIFeedRunsResult'
description: Successful Response - Returns all matching FeedRuns
summary: Get a list of Feed Runs
tags:
- Feed
components:
schemas:
UIFeedRunCarrierTransmission:
properties:
id:
description: ID of the transmission
format: uuid
type: string
sent_timestamp:
description: DateTime the transmission was sent to the carrier
type: integer
required:
- id
- sent_timestamp
type: object
UIFeedRunFile:
properties:
gcs_path:
description: Path in GCS for file
nullable: true
type: string
includes_phi:
description: Whether file included real data or not
nullable: true
type: boolean
is_test:
description: Whether file was marked test or production
nullable: true
type: boolean
name:
description: Remote name of file
type: string
required:
- gcs_path
- includes_phi
- is_test
- name
type: object
Meta:
properties:
offset:
description: The offset of the first response record within the matching data set
format: int32
minimum: 0
readOnly: true
type: integer
page_num:
description: The page number of the response records within the overall data set (1-based integer)
format: int32
minimum: 1
readOnly: true
type: integer
page_size:
description: The maximum number of response records on each page of results
format: int32
minimum: 1
readOnly: true
type: integer
total_records:
description: The total number of records in the entire matching data set
format: int32
minimum: 0
readOnly: true
type: integer
required:
- offset
- page_num
- page_size
type: object
PaginatedUIFeedRunsResult:
properties:
meta:
allOf:
- $ref: '#/components/schemas/Meta'
description: Metadata associated with the response data
response:
description: List of feed run results
items:
$ref: '#/components/schemas/UIFeedRun'
type: array
required:
- meta
- response
type: object
x-field_order:
- meta
- response
UIFeedRun:
properties:
carrier_transmission:
allOf:
- $ref: '#/components/schemas/UIFeedRunCarrierTransmission'
description: Carrier transmission generated by the run
file:
allOf:
- $ref: '#/components/schemas/UIFeedRunFile'
description: File generated by the run
workflow:
allOf:
- $ref: '#/components/schemas/UIFeedRunWorkflow'
description: Workflow for the run
type: object
UIFeedRunWorkflow:
properties:
created:
description: DateTime when the workflow was created
type: integer
id:
description: ID of workflow
format: uuid
type: string
status:
description: Status of workflow
type: string
required:
- created
- id
- status
type: object