View a Program

get

/api/restapi/program/{programId}

This endpoint returns programs that meet the following requirements:
  • The object is associated with a program with an ID value that matches the value of the {programId} path parameter.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ApiEntityProgram
Type: object
Title: ApiEntityProgram
Show Source
Nested Schema : codeValues
Type: array
The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a program.
Show Source
Nested Schema : linkedObjects
Type: array
The list of projects linked to the program.
Show Source
Nested Schema : ApiEntityCodeValueProgram
Type: object
Title: ApiEntityCodeValueProgram
Show Source
Nested Schema : ApiEntityProgramConfiguredFieldValue
Type: object
Title: ApiEntityProgramConfiguredFieldValue
Show Source
Nested Schema : ApiEntityProgramLinkedObject
Type: object
Title: ApiEntityProgramLinkedObject
Show Source

404 Response

The requested program does not exist, or you do not have access to it.
Back to Top