GET Project by ID

Overview

---

The following table contains important information about the GET method in regards to receiving the project by the id.

GET Project by Id
Method	GET
URL or Endpoint	/api/projects/projectId
Headers	Authorization
Parameters	id
Body	Not Applicable

The description of the URL parameter is as follows:

id URL Parameter
URL Parameter Name	id
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicProjectId": "string",
    "name": "string",
    "publicOrganizationId": "string",
    "orderNumber": 0,
    "isDefault": true,
    "subtitlesEnabledByDefault": true,
    "useBackupBeforeLive": true,
    "cutFromChannel": true,
    "biskoId": "string",
    "prebidConfigId": "string",
    "chromeCastApplicationId": "string",
    "drmLicenseUrl": "string",
    "fpsCertificateUrl": "string",
    "widevineLicenseUrl": "string",
    "geoBlockingEnabled": true,
    "encodingTemplateId": 0,
    "releaseChannelId": 0,
    "playerUrl": "string",
    "googleCredentialsUploaded": true,
    "tokenAuthenticationEnabled": true,
    "secureTokenSecretKey": "string"
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from the back-end.
result	object	Returns the response object.
publicProjectId	string	The ID of the project.
name	string	The name of the project.
publicOrganizationId	string	The ID of the organization.
orderNumber	integer($int32)	The order number.
isDefault	bool	Indicates whether the project is a default project.
subtitlesEnabledByDefault	bool	Indicates if subtitles are enabled by default.
useBackupBeforeLive	bool	Indicates whether the project's pre-live custom screen will automatically be shown before going live.
cutFromChannel	bool	Indicates whether only streamed content is retained in the final video after a live stream ends.
biskoId	string	The Bisko ID.
prebidConfigId	string	The configuration ID of the prebid.
chromeCastApplicationId	string	The application ID for Chromecast.
drmLicenseUrl	string	The URL for the DRM license.
fpsCertificateUrl	string	The URL for the FPS certificate.
widevineLicenseUrl	string	The URL for the Widevine license.
geoBlockingEnabled	bool	Indicates if geo-blocking is enabled.
encodingTemplateId	integer($int32)	The ID of the encoding template.
releaseChannelId	integer($int32)	The ID of the release channel.
playerUrl	string	The URL for the video player.
googleCredentialsUploaded	bool	Indicates if Google credentials have been uploaded.
tokenAuthenticationEnabled	bool	Indicates if token authentication is enabled.
secureTokenSecretKey	string	The secret key used for secure token authentication.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP status code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed