IncludedResources

IncludedResources

Additional related resources included in the response when using the include parameter

JSON Example

{
    "spaces": [
        "Space Object"
    ],
    "organizations": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "name": "string",
            "suspended": false,
            "relationships": {
                "quota": {
                    "data": {
                        "guid": "string"
                    }
                }
            },
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "domains": {
                    "href": "string",
                    "method": "string"
                },
                "quota": {
                    "href": "string",
                    "method": "string"
                },
                "default_domain": {
                    "href": "string",
                    "method": "string"
                }
            }
        }
    ],
    "domains": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "name": "string",
            "internal": false,
            "router_group": {
                "guid": "string"
            },
            "supported_protocols": [
                "string"
            ],
            "relationships": {},
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "organization": {
                    "href": "string",
                    "method": "string"
                },
                "route_reservations": {
                    "href": "string",
                    "method": "string"
                },
                "shared_organizations": {
                    "href": "string",
                    "method": "string"
                },
                "router_group": {
                    "href": "string",
                    "method": "string"
                }
            }
        }
    ],
    "service_offerings": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "name": "string",
            "description": "string",
            "available": false,
            "tags": [
                "string"
            ],
            "requires": [
                "string"
            ],
            "shareable": false,
            "documentation_url": "string",
            "broker_catalog": {
                "id": "string",
                "metadata": {
                    "displayName": "string",
                    "documentationUrl": "string",
                    "imageUrl": "string",
                    "longDescription": "string",
                    "providerDisplayName": "string",
                    "supportUrl": "string"
                },
                "features": {
                    "plan_updateable": false,
                    "bindable": false,
                    "instances_retrievable": false,
                    "bindings_retrievable": false,
                    "allow_context_updates": false
                }
            },
            "relationships": {
                "service_broker": {
                    "data": {
                        "guid": "string"
                    }
                }
            },
            "service_broker_guid": "string",
            "service_broker_name": "string",
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "service_plans": {
                    "href": "string",
                    "method": "string"
                },
                "service_broker": {
                    "href": "string",
                    "method": "string"
                }
            }
        }
    ],
    "service_instances": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "type": "string",
            "name": "string",
            "tags": [
                "string"
            ],
            "syslog_drain_url": "string",
            "route_service_url": "string",
            "dashboard_url": "string",
            "maintenance_info": {
                "version": "string",
                "description": "string"
            },
            "upgrade_available": false,
            "last_operation": {
                "type": "string",
                "state": "string",
                "description": "string",
                "created_at": "string",
                "updated_at": "string"
            },
            "relationships": {
                "space": {
                    "data": {
                        "guid": "string"
                    }
                },
                "service_plan": {
                    "data": {
                        "guid": "string"
                    }
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "space": {
                    "href": "string",
                    "method": "string"
                },
                "service_plan": {
                    "href": "string",
                    "method": "string"
                },
                "parameters": {
                    "href": "string",
                    "method": "string"
                },
                "service_credential_bindings": {
                    "href": "string",
                    "method": "string"
                },
                "service_route_bindings": {
                    "href": "string",
                    "method": "string"
                },
                "shared_spaces": {
                    "href": "string",
                    "method": "string"
                }
            },
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            }
        }
    ],
    "apps": [
        "App Object"
    ],
    "routes": [
        "Route Object"
    ],
    "users": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "username": "string",
            "presentation_name": "string",
            "origin": "string",
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                }
            }
        }
    ]
}

array of Space

spaces

Optional

Array of included space resources

array of Organization

organizations

Optional

Array of included organization resources

array of Domain

domains

Optional

Array of included domain resources

array of ServiceOffering

service_offerings

Optional

Array of included service offering resources

array of service_instances

service_instances

Optional

Array of included service instance resources

array of App

apps

Optional

Array of included app resources

array of Route

routes

Optional

Array of included route resources

array of User

users

Optional

Array of included user resources

Property Of

AppList

Role

RouteList

ServiceCredentialBindingList

ServicePlanList

ServiceRouteBindingList

SpaceList