Library Entity Associated Entities

/api/repositories/{repository}/library/entities/{libraryID}/associatedentities

Parameter	Type	Purpose
repository	string	The name of the Repository
libraryID	int	The ID of the library entity

Show All

GET /api/repositories/(string: repository)/library/entities/(int: libraryID)/associatedentities

Returns a list of all Entities associated with a Library Entity.

GET /api/repositories/jupiter/library/entities/2/associatedentities HTTP/1.1
Accept: application/json

Response Code	Reason
200	No error
400	Invalid data passed with request
404	Server error
500	Server error

The response will be a Standard Response, with a list of the Entities associated with the Library Entity; See Entities for details of the contents of the response.

Show Some

POST /api/repositories/(string: repository)/library/entities/(int: libraryID)/associatedentities

Lists all Entities associated with a Library Entity that match various criteria

JSON Parameters:  

• body – The request body

POST /api/repositories/jupiter/library/entities/2/associatedentities HTTP/1.1
Content-Type: application/json

{
    "command": "get",
    "options": {
        "pageSize":"25",
        "pageStart":"1"
    }
}

Response Code	Reason
200	Success
400	Invalid data passed with request
404	Server error
500	Server error

The request requires a Standard Request packet. The response will be a Standard Response, same as described for the above get request, with a list of Entities associated with the Library Entity that match the given criteria.

Export

Some or all of the rows may be exported as a scheduled task.

POST /api/repositories/jupiter/library/entities/2/associatedentities HTTP/1.1
Content-Type: application/json

{
    "command": "export",
    "data": {
        "filename": "filename.csv",
        "filetype": "csv",
        "encoding": "utf-8"
    },
    "options": {
        "columns": ["_humanised_name", "ENTITY_ID"],
        "where": "Ref = 1"
    }
}

Response Code	Reason
200	No error
400	Invalid data passed with request
404	Server error
500	Server error

The request packet must contain the command and data elements. The options element is not required, but may specify the columns to export, and/or the rows to filter.

The following table shows which fields are required in the data element:

Field	Required
filename	Y
filetype	N
encoding	N

If filetype is not specified, it defaults to csv. If encoding is not specified, it defaults to the server native encoding.

The response will contain the URL of the scheduled task and the link to download the exported file.

{
    "job": "/api/repositories/jupiter/scheduler/1",
    "file": "/api/repositories/jupiter/download/filename.csv"
}