REST API

Data: ns1

  • Namespace: http://genologics.com/ri/globaltoken
  • XML Schema File: ns1.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element global-token

Example XML

<?xml version="1.0" encoding="UTF-8"?> <ns1:global-token xmlns:ns1="http://genologics.com/ri/globaltoken" uri="..."> <name> <!--content of type 'string'--> ... </name> <value> <!--content of type 'string'--> ... </value> <description> <!--content of type 'string'--> ... </description> <is-custom> <!--content of type 'boolean'--> ... </is-custom> </ns1:global-token>

Element global-tokens

The representation of a list of global token links.

The system enforces a maximum number of elements when generating the list of links. When the size of the request result set is larger than the system maximum, the list represents a paged view of the overall results, and the previous-page and next-page elements provide URIs linking to the previous or next page of links in the overall results.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <ns1:global-tokens xmlns:ns1="http://genologics.com/ri/globaltoken"> <global-token uri="..."> <!--content of type 'global-token-link'--> <name> <!--content of type 'string'--> ... </name> </global-token> <global-token> <!--(another 'global-token-link' type)--> </global-token> <!--...more "global-token" elements...--> <previous-page uri="..."> <!--content of type 'page'--> </previous-page> <next-page uri="..."> <!--content of type 'page'--> </next-page> </ns1:global-tokens>

Type global-token

Attributes

name type description
uri anyURI (no documentation provided)

Child Elements

name (type) min/max
occurs
description
name (string) 0/1 (no documentation provided)
value (string) 0/1 (no documentation provided)
description (string) 0/1 (no documentation provided)
is-custom (boolean) 0/1 (no documentation provided)

Type global-token-link

global-token-link is a child element type of global tokens and provides a URI linking to the detailed representation of a global token.

Attributes

name type description
uri anyURI The URI of the Global Token.

Child Elements

name (type) min/max
occurs
description
name (string) 0/1 The name of the Global Token.

Type global-tokens

The representation of a list of global token links.

The system enforces a maximum number of elements when generating the list of links. When the size of the request result set is larger than the system maximum, the list represents a paged view of the overall results, and the previous-page and next-page elements provide URIs linking to the previous or next page of links in the overall results.

Child Elements

name (type) min/max
occurs
description
global-token (global-token-link) 0/unbounded Global Token provides a URI linking to the detailed representation of a global token.
previous-page (page) 0/1 When working with large lists of global tokens, the previous-page element provides a URI that links to the previous page of global tokens.
next-page (page) 0/1 When working with large lists of global tokens, the next-page element provides a URI that links to the next page of global tokens.

Home

REST Endpoints

XML Data Elements

XML Data Types