Skip to content

Latest commit

 

History

History
 
 

header

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 

README.md

IDS-REST# IDS-REST HTTP-Header

HTTP Headers of IDS-REST in alphabetical order

ids-authorizationToken

Authorization token. Technology and issuer can be selected by the server, is not specified further by the IDS.

  • used by: request (optional, depending on the receiving IDS Connector)

Type: xsd:string

GET /
Host: https://www.example.com
ids-authorizationToken: "eyJhbGci..."

ids-contentVersion

The version of the content in the payload.

  • used by: request (optional)

Type: xsd:string

POST /
Host: https://www.example.com
ids-contentVersion: "1.4"

ids-correlationMessage

Correlated message. Usually needed, if a messages responds to a previous message. A Connector may, e.g., send a MessageProcessedNotification as a response to an incoming message and therefore needs this property to refer to the incoming message.

  • not applicable for RESTful interactions as the server is not enforced to remember previous interactions (state-less nature).

ids-issued

DateTimeStamp of issuing the message. Default issuing time of a message is time when the HTTP message is sent. Can be used to indicate that the original source of the message - maybe a backend system proxied by the sending IDS Connector - has created the message at a different time.

  • used by: request (optional)
  • used by: response (optional)

Type: xsd:dateTimestamp

GET /
Host: https://www.example.com
ids-issued: "2019-12-02T08:25:08.245Z"

ids-issuerConnector

Original Connector of the message.

  • used by: request (optional, default issuer Connector is the sender of the request)
  • used by: response (optional, default issuer Connector is the sender of the response)

Type: xsd:anyURI

GET /
Host: https://www.example.com
ids-issuerConnector: "https://www.example.com/Connector1/"

ids-modelVersion

Information Model version, against which the Message should be interpreted. Should follow the pattern "[0-9].[0-9].[0-9]".

  • used by: request (mandatory, if the body contains an IDS Entity)
  • used by: response (mandatory, if the body contains an IDS Entity)

Type: xsd:string

PUT /
Host: https://www.example.com
ids-modelVersion: "4.0.0"

ids-recipientAgent

Agent, for which the message is intended.

  • used by: request (optional, implicitly defined by the target resource)
  • used by: response (optional, implicitly defined by the target resource)

Type: xsd:anyURI

GET /
Host: https://www.example.com
ids-recipientAgent: "https://www.example.com/Agent1"

ids-recipientConnector

Target Connector. Can be used if the target IDS Connector proxies other IDS Connectors.

  • used by: request (optional, implicitly defined by the connector hosting the target resource)
  • used by: response (optional, implicitly defined by the connector hosting the target resource)

Type: xsd:anyURI

GET /
Host: https://www.example.com
ids-recipientConnector: "https://www.example.com/Connector1"

ids-securityToken

Dynamic Attribute Token (DAT) representing the security-related claims, for instance that the sender supports a certain security profile.

  • used by: request (mandatory)
  • used by: response (mandatory)

Type: xsd:string

GET /
Host: https://www.example.com
ids-securityToken: "eyJhbGci..."

ids-senderAgent

Agent who initiated the response. Can be used if the sending IDS Connector acts on behalf of (see user agents in REST) more than one IDS Participant.

  • used by: request (optional)
  • used by: response (optional)

Type: xsd:anyURI

GET /
Host: https://www.example.com
ids-senderAgent: "https://www.example.com/Agent1"

ids-transferContract

The contract which is (or will be) the legal basis of the data transfer.

  • used by: request (optional)
  • used by: response (optional)

Type: xsd:anyURI

GET /
Host: https://www.example.com
ids-transferContract: "https://www.example.com/ContractAgreement1"

Http headers of LDP in alphabetical order

Accept

A comma-separated list of MIME types, which the client wants to accept. Default is '/'.

  • used by: request (optional)

Type: mimetypes or mimetype patterns (e.g. /* or /)

GET /
Host: https://www.example.com
Accept: "text/turtle, application/ld+json"

see also

Accept-Post

A comma-separated list of allowed media types, for instance text/turtle, application/ld+json (for descriptions conforming to the IDS Information Model), or application/octet-stream (for binary data or IDS Artifacts).

  • used by: response (optional)
  • Type: comma-separated list of mimetypes
/
Host: https://www.example.com
Accept-Post: "text/turtle, application/ld+json"

see also

Allow

The enabled HTTP methods, selection of GET, OPTIONS, HEAD, PUT, PATCH, POST, DELETE, CONNECT.

  • used by: response (mandatory)
  • Type: comma-separated list of HTTP methods

Example:

Allow: "GET, OPTIONS, HEAD"

see also

Content-Type

The MIME type of the request body.

  • used by: request (mandatory, if a body is present)
  • used by: response (mandatory, if a body is present)

Type: mimetype

GET /
Host: https://www.example.com
Content-Type: "application/ld+json"

see also

ETag

A unique version identifier representing the current state of the requested resource.

  • used by: response (mandatory)

Type: xsd:string

ETag: "42424242424242"

see also

If-Match

The version of the resource the client wants to change. Is used to detect collisions. The client is informed by the server of correct versions through the ETag response header.

  • used by: request (mandatory, if the client wants to overwrite a remote resource)
  • used by: request (mandatory for PUT and DELETE, optional else)

Type: xsd:string

PUT /
Host: https://www.example.com
If-Match: "42"

see also

Link

<IDS class URI>; rel="type"

and

<http://www.w3.org/ns/ldp#Resource>; rel="type"

and/or

<http://www.w3.org/ns/ldp#BasicContainer>; rel="type"
  • used by: response (mandatory, if the body contains a LDP or IDS resource)

Type: comma-separated list of relation statements

GET /
Host: https://www.example.com
Link: <https://w3id.org/idsa/core/DataResource>; rel="type", <http://www.w3.org/ns/ldp#Resource>; rel="type", <http://www.w3.org/ns/ldp#BasicContainer>; rel="type"

see also

Location

The location of a newly created resource.

  • used by: response (mandatory if a response to a POST that created a new accessible resource, else optional)

Type: xsd:anyURI

POST /
Host: https://www.example.com
Location: "./spider-pig"

Slug

The desired new name of a resource, which the client wants to create.

  • used by: request (optional)

Type: xsd:string

POST /
Host: https://www.example.com
Slug: "spider-pig"

see also

Authors
Sebastian Bader GitHub sebbader
Jörg Langkau Mail [email protected]
GitHub jlangkau
twitter @LostInDataSpace