Get associated media agents detail for a Plan

Select

SaaS

Customer Managed

Get list of associated media agents detail for a Plan

Path Parameters

• planId int32 required

  Plan id of the plan

Query Parameters

• packageName

  Possible values: [CVS3Service]

  Provide the name of the package that needs to be checked if installed on the Media Agents. isPackageInstalled will be populated accordingly. By default it checks for Media agent package. Refer to packageName list.

Responses

• 200
• 400
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• mediaAgentsList object[]

  id int32

  Id of the Media agent

  name string

  Name of the Media agent

  isPackageInstalled boolean

  Indicates if packageName sent in query parameter is installed on the Media agent

  regionName string

  Name of the region where Media agent belongs to within the Plan

{
  "mediaAgentsList": [
    {
      "id": 0,
      "name": "string",
      "isPackageInstalled": true,
      "regionName": "string"
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Loading...