Resource

Get Resource JSON Format

GET http://localhost/api_v1/targets/:target_name:/resources/:resource_id:.json/

This endpoint allows you to get the details of a resource with a given resource_id in JSON format

Path Parameters

Name	Type	Description
target_name	string	Name of the Target
resource_id	string	ID of the Resource

Headers

Name	Type	Description
presqt-source-token	string	User's Target Token

200 Resource successfully retrieved

{
    "kind": "item",
    "kind_name": "file",
    "id": "5cd98518f244ec001ee8606b",
    "title": "23296359282_934200ec59_o.jpg",
    "date_created": "2019-05-13T14:54:17.129170Z",
    "date_modified": "2019-05-13T14:54:17.129170Z",
    "hashes": {
        "md5": "aaca7ef067dcab7cb8d79c36243823e4",
        "sha256": "ea94ce54261720c16abb508c6dcd1fd481c30c09b7f2f5ab0b79e3199b7e2b55"
    },
    "extra": {
        "last_touched": null,
        "materialized_path": "/Images/23296359282_934200ec59_o.jpg",
        "current_version": 1,
        "provider": "osfstorage",
        "path": "/5cd98518f244ec001ee8606b",
        "current_user_can_comment": true,
        "guid": null,
        "checkout": null,
        "tags": [],
         "size": 1773294,
    },
    "download_url": http://localhost/api_v1/targets/osf/resources/5cd98518f244ec001ee8606b.zip/" 
}

400 The target provided does not support the action requested or 'presqt-source-token' is missing in the headers

{
    "error": "'new_target' does not support the action 'resource_detail'."
}
or
{
    "error": "'presqt-source-token' missing in the request headers."
}

401 The provided token is invalid

{
    "error": "Token is invalid. Response returned a 401 status code.""
}

404 Could not find a matching target

{
    "error": "'bad_target' is not a valid Target name."
}

Get Resource Zip Format

GET http://localhost/api_v1/targets/:target_name:/resources/:resource_id:.zip/

This endpoint allows you to get the resource with the given resource_if as a ZIP file.

Path Parameters

Name	Type	Description
target_name	string	Name of the Target
resource_id	string	ID of the Resource

Headers

Name	Type	Description
presqt-source-token	string	User's Target Token

200

Upload Resource To Container

POST http://localhost/api_v1/targets/:target_name:/resources/:resource_id:/

This endpoint allows you to upload resources to an existing container

Path Parameters

Name	Type	Description
target_name	string	Name of the Target
resource_id	string	ID of the Resource

Headers

Name	Type	Description
duplicate-file-action	string	Flag for handling file duplication. Must be either 'ignore' or 'update'.
presqt-detination-token	string	User's token for the destination target

Request Body

Name	Type	Description
presqt-file	object	Zip of the resources to upload

202 Resource upload has successfully started

{
    "ticket_number": "some_uuid"
    "message": "The server is processing the request."
}

400 The target provided does not support the requested action or 'presqt-destination-token' missing in the request headers or 'presqt-file' not found in the body or The file provided is not a zip file or The file provided is not in BagIt format or Checksums in the bag did not validate or 'presqt-file-duplicate-action' missing in request headers or Invalid duplicate action was provided

{
    "error": "'new_target' does not support the action 'resource_upload'."
}
or
{
    "error": "'presqt-destination-token' missing in the request headers."
}
or
{
    "error": "The file, 'presqt-file', is not found in the body of the request."
}
or
{
    "error": "The file provided, 'presqt-file', is not a zip file."
}
or
{
    "error": "The file provided is not in BagIt format."
}
or
{
    "error": "Checksums failed to validate."
}
or
{
    "error": "'presqt-file-duplicate-action' missing in the request headers."
}
or
{
    "error": "'bad_action' is not a valid file_duplicate_action.
    The options are 'ignore' or 'update'."
}

401 The provided token is invalid

{
    "error": "Token is invalid. Response returned a 401 status code."
{

403 User does not have access to the requested resource with the token provided

{
    "error": "User does not have access to this resource with the token provided."
}

404 Could not find a matching target

{
    "error": "'bad_name' is not a valid Target name."
}

410 The requested resource is no longer available

{
    "error": "The requested resource is no longer available."
}