GET
This method returns discovery information for resources.
This API:
- Produces the following content types:
application/xrd+xml - Sample Output URI:
HTTP Request /api/info?uri=/api/space/user-management/users
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<XRD>
<Subject>
/api/space/user-management/users</Subject>
<Link rel="describedBy" type="application/xrd+xml" href="/api/info?type=vnd.net.juniper.space.user-management.users" />
<http-methods>
<http-method type="GET">
<primary-uri>
/api/space/user-management/users</primary-uri>
<headers>
<header type="Accept">
<Link rel="describedBy" type="application/xrd+xml" href="/api/info?type=vnd.net.juniper.space.user-management.users" />
<representations>
<representation>
application/vnd.net.juniper.space.user-management.users+json;version=1 </representation>
<representation>
application/vnd.net.juniper.space.user-management.users+xml;version=1 </representation>
</representations>
</header>
</headers>
</http-method>
<http-method type="POST">
<primary-uri>
/api/space/user-management/users</primary-uri>
<headers>
<header type="Accept">
<Link rel="describedBy" type="application/xrd+xml" href="/api/info?type=vnd.net.juniper.space.user-management.user" />
<representations>
<representation>
application/vnd.net.juniper.space.user-management.user+json;version=1 </representation>
<representation>
application/vnd.net.juniper.space.user-management.user+xml;version=1 </representation>
</representations>
</header>
<header type="Content-Type">
<Link rel="describedBy" type="application/xrd+xml" href="/api/info?type=vnd.net.juniper.space.user-management.user" />
<representations>
<representation>
application/vnd.net.juniper.space.user-management.user+json;version=1;charset=UTF-8 </representation>
<representation>
application/vnd.net.juniper.space.user-management.user+xml;version=1;charset=UTF-8 </representation>
</representations>
</header>
</headers>
</http-method>
</http-methods>
</XRD>
; - Sample Output Media Type:
HTTP Request /api/info?type=vnd.net.juniper.space.user-management.users
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<XRD>
<type-descriptor>
<name>
vnd.net.juniper.space.user-management.users</name>
<versions>
<version num="1">
<representation>
xml</representation>
<representation>
json</representation>
<type-v>
vnd.net.juniper.space.user-management.users;version=1 </type-v>
<schema href="/api/info?type-v=vnd.net.juniper.space.user-management.users;version=1" />
</version>
</versions>
</type-descriptor>
</XRD>
- Sample Output for media type version:
HTTP Request /api/info?type-v=vnd.net.juniper.space.user-management.users;version=1
<xs:schema version="1.0">
<xs:element name="user-management" type="user-management"/>
<xs:complexType name="user-management">
<xs:sequence>
<xs:element name="method" type="hateoasMethodObject" minOccurs="0"/>
<xs:element name="collection" type="hateoasMethodObject" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="hateoasMethodObject">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
</xs:complexType>
</xs:schema>
Parameters
name | description | type | default |
---|---|---|---|
uri | URL for which information is required | query | |
type | Media type for which information is required | query | |
type-v | Version of a media type for which information is required | query |
Output Payload
element | @Produce content type(s) |
---|---|
(custom) |
|
description | |
Meta-data for passed url/media-type or media type version |