Home
Version 3
Service Plan Visibilities API

Service Plan Visibilities API

List all Service Plan Visibilities

GET /v2/service_plan_visibilities

Request

Route

GET /v2/service_plan_visibilities

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: organization_guid, service_plan_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NyIsImVtYWlsIjoiZW1haWwtMTc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MDl9.sF_joQ6k1hjpk-JiqdIinsNoG11_qFwdHZlNSmCUxzw
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_plan_visibilities" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NyIsImVtYWlsIjoiZW1haWwtMTc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MDl9.sF_joQ6k1hjpk-JiqdIinsNoG11_qFwdHZlNSmCUxzw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "06fb616c-d82c-4519-8340-b2bd774c61da",
        "url": "/v2/service_plan_visibilities/06fb616c-d82c-4519-8340-b2bd774c61da",
        "created_at": "2015-03-10T23:11:49Z",
        "updated_at": null
      },
      "entity": {
        "service_plan_guid": "881bf583-eb72-4a28-aaaa-f90abfe60c48",
        "organization_guid": "b85f78af-eba5-4bd0-ab49-57ea40747086",
        "service_plan_url": "/v2/service_plans/881bf583-eb72-4a28-aaaa-f90abfe60c48",
        "organization_url": "/v2/organizations/b85f78af-eba5-4bd0-ab49-57ea40747086"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d5f8f376-d20f-48ed-9f79-888c15fe5daa
Content-Length: 696
X-Content-Type-Options: nosniff