Jump to

• Request
• Response

Perform the update external status action to a resource

post

/custom-actions/changeExternalStatus/<resourceName>/{resourceGid}

Request

Path Parameters

• resourceGid(required): string
  Resource ID

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• statusValueXid: string
  The value of the status type.

{
    "properties":{
        "statusValueXid":{
            "type":"string",
            "description":"The value of the status type."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default response.

Body ()

Root Schema : actionResponse

Type: object

Show Source

• success: string
  Success or failure.

{
    "properties":{
        "success":{
            "description":"Success or failure.",
            "type":"string"
        }
    }
}

400 Response

The default response.

Body ()

Root Schema : errorResponse400

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The default response.

Body ()

Root Schema : errorResponse500

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top