Apply Service Plan Visibility

Apply a service plan visibility

This endpoint applies a service plan visibility. It behaves similar to the PATCH service plan visibility endpoint but this endpoint will append to the existing list of organizations when the service plan is organization visible.

Request

URI

POST

https://api.example.local/v3/service_plans/{guid}/visibility

COPY

Path Parameters

string

guid

Required

The unique identifier for the resource

Request Body

Service plan visibility object that needs to be created

ServicePlanVisibilityCreateRequestBody of type(s) application/json

Optional

Show optional properties

{
    "type": "string"
}

{
    "type": "string",
    "organizations": [
        {
            "guid": "string"
        }
    ]
}

Authentication

This operation uses the following authentication methods.

oauth

bearer

Responses

200

Returns ServicePlanVisibility of type(s) application/json

{
    "type": "string",
    "organizations": [
        {
            "guid": "string",
            "name": "string"
        }
    ]
}

string

type

Required

Type of visibility

Possible values are : public, admin, organization, space,

array of object

organizations

Optional

Organizations that have visibility to this service plan

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

404

Not Found

Returns NotFound of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

409

Conflict

Returns Conflict of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

422

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

500

Internal Server Error

Returns 500 of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

503

Service Unavailable

Returns ServiceUnavailable of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"type":"string"}' https://{api_host}/v3/service_plans/{guid}/visibility

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Service Plans Operations

GET

List Service Plans