Jump to

• Request
• Response
• Examples

Publish or Unpublish a Program

patch

/rest/api/v1.3/programs/{programName}

Use this interface to publish a valid program or unpublish a program.

Request

Supported Media Types

• application/x-www-form-urlencoded

Path Parameters

• programName: string
  Name of the Program to be published or unpublished

Body ()

Root Schema : update-program-request

Type: object

Title: update-program-request

Show Source

• action(optional): string
  Allowed Values: [ "publish", "unpublish" ]

  Action to be performed on a given program
• saveDraft(optional): string
  Allowed Values: [ "Y", "N" ]

  Indicates whether to save the draft version or published version

{
    "title":"update-program-request",
    "type":"object",
    "properties":{
        "action":{
            "description":"Action to be performed on a given program",
            "enum":[
                "publish",
                "unpublish"
            ],
            "type":"string"
        },
        "saveDraft":{
            "description":"Indicates whether to save the draft version or published version",
            "enum":[
                "Y",
                "N"
            ],
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : update-program-response

Type: object

Title: update-program-response

Show Source

• errorMsg(optional): string
  Error messages when publish or unpublish fails
• status(optional): string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  Returns SUCCESS if the publish or unpublish is successful. Returns FAILURE if action is not successful.

{
    "title":"update-program-response",
    "type":"object",
    "properties":{
        "status":{
            "description":"Returns SUCCESS if the publish or unpublish is successful. Returns FAILURE if action is not successful.",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ],
            "type":"string"
        },
        "errorMsg":{
            "description":"Error messages when publish or unpublish fails",
            "type":"string"
        }
    }
}

Back to Top

Examples

This interface is used to publish and unpublish programs.

A successful request requires the following headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Sample Request Body:

Publish a program.

{
  "action": "publish",
  "saveDraft": "Y"
}
	

Sample Response: Success

{
  "status": "SUCCESS",
  "errorMsg": []
}
	

Sample Response: Failure

In the following sample response body, the request parameter action was not set to 'publish' or 'unpublish'.

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Request parameter 'action' should be set as 'unpublish' or 'publish'",
  "errorDetails": []
}
    

Back to Top