Examples (List of resource type names)

See https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2214264841

Example

GET https://club-wed.wedia-group.com/api/rest/dam?headers=false

Get the service DAM catalog.

Code examples

The following examples are given with a Basic authentication with bogus credentials.

HTTP

GET /api/rest/dam?headers=false HTTP/1.1 Authorization: Basic ZGVtbzpkZW1vcHdk Host: club-wed.wedia-group.com

cURL

curl --request GET --url 'https://club-wed.wedia-group.com/api/rest/dam?headers=false' --header 'Authorization: Basic ZGVtbzpkZW1vcHdk'

JavaScript/fetch

fetch("https://club-wed.wedia-group.com/api/rest/dam?headers=false", { "method": "GET", "headers": { "Authorization": "Basic ZGVtbzpkZW1vcHdk" } }) .then(response => { console.log(response); }) .catch(err => { console.error(err); });

JavaScript/XMLHttpRequest

Java/Unirest (Basic)

Python/Request

Response sample

Since the response may vary depending on the state of the data, the query parameters, the resource configuration, and the data model, a response is presented here that may be somewhat different from what you will get in your implementation. Not all sections are documented here for the same reasons. The debug sections in particular are not documented on this page.

Response

This documentation describes all the exposable properties. The documentation of the API (ReDoc or SwaggerUI) of the usage environment is more specific to the environment and will detail the information actually exposed on it.

JSON Path

The path to the property

Type*

Type of information

JSON Type

The type of the value

Description

The description of the value

Presence

When this property is exposed

Comment

JSON Path

The path to the property

Type*

Type of information

JSON Type

The type of the value

Description

The description of the value

Presence

When this property is exposed

Comment

$

STRUCT

Object

The response for end point invocation (root)

Always

 

$.response

STRUCT

Object

Data specific to the call for service response

Always

 

$.version

TECH

String

Version of the API end point

Always

 

$.apiversion

TECH

String

Version of the API

Always

 

$.response.total

AGPG

Number

The total number of resource types corresponding to the request

Always

 

$.response.count

AGPG

Number

The number of resource types in this response

Always

 

$.response.data

STRUCT

Array of strings

List of resource type names

Always

 

*The property type classifies properties into 6 types:

  • DATA: the data properties of the resource, such as its name, its metadata...

  • TECH: related technical properties, such as the URL of the preview, or the description of the workflow

  • STRUCT: structural data of the JSON response, such as the hateoas link section, the header description

  • META: metadata about the type of resource, such as its name or description

  • AGPG: aggregate or pagination metadata (counters, page numbers, etc), HATEOAS, etc

  • OTHERS: other