Library ingests

>>>

GET /api/v1/library_ingests
Display a list of all Library Ingests.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

POST /api/v1/library_ingests
Create a new Library Ingest.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
library_ingest
optional , nil allowed

Validations:

  • Must be a Hash
library_ingest[project_id]
required

ID of project to ingest into.

Validations:

  • Must be a String
library_ingest[ingest_storage]
required

Name of storage to ingest into.

Validations:

  • Must be a String
library_ingest[ingest_path]
required

Path of folder to ingest from.

Validations:

  • Must be a String
library_ingest[transmission_check]
required
sha2 | crc | fingerprint | md5 | none

The method of data verification for a library.

Validations:

  • Must be a String
library_ingest[options]
optional , nil allowed

Additional options.

Validations:

  • Must be a Hash
>>>

PUT /api/v1/library_ingests/:id
Display a library ingest.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
library_ingest
optional , nil allowed

Validations:

  • Must be a Hash
library_ingest[project_id]
optional

ID of project to ingest into.

Validations:

  • Must be a String
library_ingest[ingest_storage]
optional

Name of storage to ingest into.

Validations:

  • Must be a String
library_ingest[ingest_path]
optional

Path of folder to ingest from.

Validations:

  • Must be a String
library_ingest[transmission_check]
optional
sha2 | crc | fingerprint | md5 | none

The method of data verification for a library.

Validations:

  • Must be a String
library_ingest[options]
optional , nil allowed

Additional options.

Validations:

  • Must be a Hash
>>>

DELETE /api/v1/library_ingests/:id
Delete a library ingest.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the library ingest to delete.

Validations:

  • Must be a String