Manage Service
Manage Service

About

The Manage service provides methods for creating resources in RUcore.

The base URL for our Manage service is

Responses

Responses can be returned in XML or JSON depending on the response format requested. Further detail can be found under each methods documentation.

HTTP Response Codes

401 failed; no credentials or invalid credentials supplied
405 failed; method not supported
500 failed; server error contact support

Methods

  • Add - Add a resource to the repository

Add

Top

Add a resource to the repository

HTTP Method

POST

HTTP Response Codes

201 success; resource added
400 failed; supplied values are not valid

URI

https://rucore.libraries.rutgers.edu/api/manage/

Authentication

HTTP Basic authentication (BA) is required when using this method. Contact us if you need a username/password combination.

Arguments

  • payload required : string; UTF-8 encoded. JSON object containing metadata. Schema is as follows.

    • type required Type of resource being created. Options supported are: RAW and L0
    • date required
      • value Date value. With types RAW and LO the date value is the start date of the data capture.
      • format Value format. Options supported are: ISO8601 and POSIX
    • identifier required
      • value Identifier value.
      • type Value type. Options supported are: OOI
    • permalink required repeatable
    • parent required
      • value Identifier of parent resource. RAW and L0 resources parent is the instrument/sensor.
      • type Type of identifier. Options support are: DOI, RUCORE, OOI
    • parsedFrom optional Provide when creating a L0 resource and the corresponding RAW data has an identifier
      • value Identifier of RAW data that was parsed when generating the L0 data.
      • type Type of identifier. Options support are: DOI, RUCORE, OOI
    • parser optional Provide when creating a L0 resource
      • value Identifier of parser used to generate L0 data.
      • type Type of identifier. Options support are: DOI, RUCORE, OOI
    • versionOf optional When creating a resource type L0 that has a previous version supply the identifier of the previous version of the L0 data. A typical use case is when introducing a new version of a parser and historical L0 data needs to be reprocessed from corresponding RAW data.
      • value Identifier of previous version of L0 data.
      • type Type of identifier. Options support are: DOI or RUCORE
    • title optional Human readable and friendly title for resource being created. If not provided one will be constructed based on several parameters.
    • description optional Human readable and friendly description of resource being created

  • response : string
    optional Response format, JSON is the default response format. Options supported are: JSON and XML

Sample Payload

Sample response as JSON

HTTP status code 201 success; resource added

Sample response as XML

HTTP status code 201 success; resource added

Background

RUcore has been developing web services that allow software applications to easily interact with our repository framework of services. These web services are REST based and typically respond to requests in XML or JSON.

Web Services

Listserv and Google Group

A listserv has been established that will be used to communicate service outages and RUcore web service related news. The listserv address is rucore_web_services[at]email.rutgers.edu. Visit this page to subscribe.

A Google Group has been created to provide a place for discussion about the web services RUcore provides.

If you have any further questions please contact us.
Version 8.2.5
Rutgers University Libraries - Copyright ©2017