Objects Endpoint

The /member-api/v1/objects endpoint currently supports only GET requests, meaning it is a read-only endpoint for now.

GET /member-api/v1/objects 

This endpoint returns a list of Intellectual Objects belonging to your institution. Intellectual Objects are usually fully ingested bags, though when bags are uploaded in multiple parts, the Intellectual Object may appear before all of the component bags are fully ingested.

Filter Parameters

The endpoint accepts the following query string parameters to filter results.
  • name_exact - Return only the Intellectual Object with this exact name. The name has the format of institution domain, followed by a slash, followed by the bag name. For example, "virginia.edu/virginia.bag_of_photos". When you include this parameter, you must url-encode the slash as %2F.
  • name_contains - Return only those Intellectual Objects whose name contains the specified string.
  • page - Return page X of results, where X is an integer. If this is not specified, it defaults to 1.
  • per_page - The number of items to include in the page of results. If this is not specified, it defaults to 10.
JSON Response Format
{
    "count": 15,
    "next": "http://localhost:3000/member-api/v1/objects/?page=3&per_page=5&updated_since=2016-01-27T00:00:00Z",
    "previous": "http://localhost:3000/member-api/v1/objects/?page=1&per_page=5&updated_since=2016-01-27T00:00:00Z",
    "results": [
        {
            "id": "changeme:55506",
            "title": "Roots of Alternative Medicine",
            "description": "",
            "access": "consortia",
            "bag_name": "virginia.edu_dc3acb8",
            "identifier": "virginia.edu/virginia.edu_dc3acb8",
            "state": "A",
            "alt_identifier": ["med:377892276"]
        },
        {
            "id": "changeme:55511",
            "title": "Test Bag For IU",
            "description": "",
            "access": "consortia",
            "bag_name": "iu.edu.testbag1",
            "identifier": "test.edu/iu.edu.testbag1",
            "state": "A",
            "alt_identifier": []
        },
        {
            "id": "changeme:55517",
            "title": "Our Friend the Beaver",
            "description": "",
            "access": "consortia",
            "bag_name": "test_oftb_19820116",
            "identifier": "test.edu/test_oftb_19820116",
            "state": "A",
            "alt_identifier": ["0089771632555"]
        },
        {
            "id": "changeme:55522",
            "title": "APTrust/DPN Test Bag 3",
            "description": "",
            "access": "consortia",
            "bag_name": "test.edu.bag3",
            "identifier": "test.edu/test.edu.bag3",
            "state": "A",
            "alt_identifier": []
        },
        {
            "id": "changeme:55525",
            "title": "APTrust/DPN Test Bag 4",
            "description": "",
            "access": "consortia",
            "bag_name": "test.edu.bag4",
            "identifier": "test.edu/test.edu.bag4",
            "state": "A",
            "alt_identifier": []
        }
    ]
} 

Updated on Mar 29, 2016 by Andrew Diamond (Version 5)