Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


OPTIONS /stmts

Explain Statement service

Expand
titleExpand details
Description
Provides link to API documentation and a list of available HTTP verbs for the Statement path.
Request
MethodOPTIONS
Relative path/stmts
Path paramn/a
Example URLhttps://demo.rmap-hub.org/api/stmts
Headersn/a
Bodyn/a
Response
HeadersAllow *HEAD,OPTIONS,GET
Link *<link_to_documentation><{link-to-documentation}>;rel="http://purl.org/dc/terms/description"
Bodyn/a
Codes200OK
500Internal server error
503Service unavailable



HEAD /stmts

Statement service status

Expand
titleExpand details
Description
Provides link to API documentation and a list of available HTTP verbs for the Statement path.
Request
MethodHEAD
Relative path/stmts
Path paramn/a
Example URLhttps://demo.rmap-hub.org/api/stmts
Headersn/a
Bodyn/a
Response
HeadersAllow *HEAD,OPTIONS,GET
Link *<link_to_documentation><{link-to-documentation}>;rel="http://purl.org/dc/terms/description"
Bodyn/a
Codes200OK
500Internal server error
503Service unavailable

GET /smts/{s}/{p}/{o}/discos

Retrieve DiSCOs containing a specific assertion

Expand
titleExpand details
Description
Retrieve a list of URIs for RMap DiSCOs that contain a specific assertion.
Request
MethodGET
Path

/stmts/{s}/{p}/{o}/discos

Path params


s *Subject part of statement
p *Predicate part of statement
o *Object part of statement - supports language and type for literals, where present
Query string paramsstatus

Status of DiSCO or Agent that contains the Statement

  • all
  • active (default)
  • inactive
from

Date from applied to DiSCO or Agent's creation Event start date

yyyyMMddHHmmss or yyyyMMdd

until

Date until applied to DiSCO or Agent's creation Event start date

yyyyMMddHHmmss or yyyyMMdd

agents

Comma separated list of RMap Agent URIs. This will filter the DiSCOs by the Agent that generated them.

pagePage number. Default is 1.
limitNumber of URIs to retrieve. Default is 200. If over 200 URIs are retrieved, the system will automatically paginate.
Example URL

Using this statement: <https://osf.io/rxgmb/> <http://purl.org/dc/terms/identifier> <ark:/c7605/osf.io/rxgmb> .

https://demo.rmap-hub.org/api/stmts/https%3A%2F%2Fosf.io%2Frxgmb%2F/http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Fidentifier/ark%3A%2Fc7605%2Fosf.io%2Frxgmb/discos?status=all

Headers

Accept

(choose one)

  • application/json (default)
  • text/plain
Bodyn/a
Response
HeadersLink<link_to_next_page_of_results>

<https://{api-path}/stmts/{s}/{p}/{o}/discos?{params-for-next-page}>;rel="next"

(only appears when paginating and not last page)

Link<link_to_previous_page_of_results>

<https://{api-path}/stmts/{s}/{p}/{o}/discos?{params-for-prev-page}>;rel="previous"

(only appears when paginating and not on first page)

Link<link_to_first_page_of_results>

<https://{api-path}/stmts/{s}/{p}/{o}/discos?{params-for-first-page}>;rel="first"

(only appears when paginating and not on first page)

Content-Type *

Matches Accept header

  • application/json (default)
  • text/plain
Body

Example (application/json):

Code Block
languagejs
{
  "http://rmap-project.org/rmap/terms/DiSCO": [
    "rmap:rms18md23a4",
	"rmap:r23fleowpa5"
  ]
}

Example (text/plain):

Code Block
languagetext
rmap:rms18md23a4
rmap:r23fleowpa5
Response codes





200OK
404Not found (if Statement does not exist in RMap)
500Internal server error
503Service unavailable

GET /stmts/{s}/{p}/{o}/agents

Retrieve Agents that made a specific assertion

Expand
titleExpand details
Description
Retrieve a list of URIs for RMap Agents that made a specific assertion
Request
MethodGET
Path

/stmts/{s}/{p}/{o}/agents

Path paramss *Subject part of statement
p *Predicate part of statement
o *Object part of statement - supports language and type for literals, where present
Query string paramsstatus

Status of DiSCO or Agent that contains the Statement

  • all
  • active (default)
  • inactive
from

Date from applied to DiSCO's creation Event start date

yyyyMMddHHmmss or yyyyMMdd

until

Date until applied to DiSCO's creation Event start date

yyyyMMddHHmmss or yyyyMMdd

pagePage number. Default is 1.
limitNumber of URIs to retrieve. Default is 200. If there are more URIs than the limit, the system will automatically paginate.
Example URL

Using this statement: <https://osf.io/rxgmb/> <http://purl.org/dc/terms/identifier> <ark:/c7605/osf.io/rxgmb> .

https://demo.rmap-hub.org/api/stmts/https%3A%2F%2Fosf.io%2Frxgmb%2F/http%3A%2F%2Fpurl.org%2Fdc%2Fterms%2Fidentifier/ark%3A%2Fc7605%2Fosf.io%2Frxgmb/agents?status=all

Headers

Accept

(choose one)

  • application/json (default)
  • text/plain

Bodyn/a
Response
HeadersLink<link_to_next_page_of_results>

<https://{api-path}/stmts/{s}/{p}/{o}/agents?{params-for-next-page}>;rel="next"

(only appears when paginating and not last page)

Link<link_to_previous_page_of_results>

<https://{api-path}/stmts/{s}/{p}/{o}/agents?{params-for-prev-page}>;rel="previous"

(only appears when paginating and not on first page)

Link<link_to_first_page_of_results>

<https://{api-path}/stmts/{s}/{p}/{o}/agents?{params-for-first-page}>;rel="first"

(only appears when paginating and not on first page)

Content-Type *

Matches Accept header

  • application/json (default)
  • text/plain
Body

Example (application/json):

Code Block
languagejs
{
  "http://rmap-project.org/rmap/terms/Agent": [
    "rmap:rmd18md23j4",
	"rmap:r23flzowpa5"
  ]
}

Example (text/plain):

Code Block
languagetext
rmap:rmd18md23j4
rmap:r23flzowpa5
Response codes





200OK
404Not found (if no matching Statement found in RMap)
500Internal server error
503Service unavailable