API Documentation

RepoServices

/repositories

Mount Point: /repositories

POST

Register a new Repository

Request Body

element:	profileString
media types:	application/json

profileString is a json profile document for the new repository.

Response Body

element:	(custom)
media types:	application/json

201: {orgidentifier: <repository_identifier>}
400 Bad Request: {response: "Failure", reason : <string>}
409 Conflict: {response: "Failure", reason : <string>}

GET

Return the list of repositories

Response Body

element:	(custom)
media types:	application/json

[
 {
  "orgidentifier":<repository_id>,
  "repositoryUrl":<repository_url>,
  "repositoryName":<repo_name>,
  "lastUpdate":<profile update date>
 }
]

/repositories/{id}

Mount Point: /repositories/{id}

The following operations are supported on this resource:

• GET
• PUT
• DELETE

GET

Return the profile for a given repository

Parameters

name	description	type	default
id	the assigned repository ID	path

Response Body

element:	(custom)
media types:	application/json

200 OK: {"orgidentifier":<repository_id>, "repositoryUrl":<repository_url>,... }
404 Not Found: {failure : <string>}

PUT

Update the profile for a given repository. The orgidentifier element in the new profile must exist and must match the {id} being PUT.

Parameters

name	description	type	default
id	the assigned repository ID	path

Request Body

element:	profile
media types:	application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/json

200 OK: {response : <string>}
404 Not Found: {failure : <string>}

DELETE

Unregister a repository and remove its profile

Parameters

name	description	type	default
id	the assigned repository ID	path

Response Body

element:	(custom)
media types:	*/* application/xml application/json

200 OK: {response : <string>}
404 Not Found: {failure : <string>}

/repositories/{id}/researchobjects

Mount Point: /repositories/{id}/researchobjects

GET

Return the set of ROs for a given repository

Parameters

name	description	type	default
id	(no documentation provided)	path
Purpose	filter by the purpose flag of the research object; the values for the 'purpose' can be 'Production' or 'Testing-Only'	query

Response Body

element:	(custom)
media types:	application/json

An array of JSON objects that include the Identifier and Title of the Aggregation, the Repository id, and the list of Status messages

/repositories/{id}/researchobjects/new

Mount Point: /repositories/{id}/researchobjects/new

GET

Return the set of new ROs for a given repository (those that have no status messages from the repository associated with them).

Parameters

name	description	type	default
id	(no documentation provided)	path
Purpose	filter by the purpose flag of the research object; the values for the 'purpose' can be 'Production' or 'Testing-Only'	query

Response Body

element:	(custom)
media types:	application/json

An array of JSON objects that include the Identifier and Title of the Aggregation, the Repository id, and the list of Status messages (e.g. those from sead-cpr itself)