import {PACSQuery} from '@fnndsc/chrisapi'

public class | source

PACSQuery

Extends:

Resource → ItemResource → PACSQuery

PACS query item resource object representing a PACS query.

Constructor Summary

Public Constructor
public	constructor(url: string, auth: Object) Constructor

Method Summary

Public Methods
public	delete(timeout: number): Promise Make a DELETE request to delete this PACS query resource through the REST API.
public	getRetrieves(params: Object, timeout: number): Promise<PACSRetrieveList> Fetch a paginated list of PACS retrieves associated to this PACS query from the REST API given query search parameters.
public	put(data: Object, timeout: number): Promise<this> Make a PUT request to modify this PACS query resource through the REST API.

Inherited Summary

From class Resource
public static	cloneObj(obj: Object): * Helper method to make a deep copy clone of the passed object resource.
public get	isEmpty: boolean Return true if the resource object contains any data.
public	auth: Object
public	collection: Object
public	contentType: string
public	url: string
public	clone(): Resource Make a deep copy clone of this object resource.

From class ItemResource
public get	data: Object Get the item's data object (REST API descriptors).
public	collection: *
public	get(timeout: number): Promise<this> Fetch this item resource from the REST API.
public	getPUTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in PUT requests.
private	_delete(timeout: number): Promise Internal helper method to make a DELETE request to this item resource through the REST API.
private	_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Promise<ResourceClass> Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.
private	_put(data: Object, uploadFileObj: Object, timeout: number): Promise<this> Internal helper method to make a PUT request to this item resource through the REST API.

Public Constructors

public constructor(url: string, auth: Object) source

Constructor

Override:

ItemResource#constructor

Params:

Name	Type	Attribute	Description
url	string		url of the resource
auth	Object		authentication object
auth.token	string		authentication token

Public Methods

public delete(timeout: number): Promise source

Make a DELETE request to delete this PACS query resource through the REST API.

Params:

Name	Type	Attribute	Description
timeout	number	optional default: 30000	request timeout

Return:

Promise

JS Promise

public getRetrieves(params: Object, timeout: number): Promise<PACSRetrieveList> source

Fetch a paginated list of PACS retrieves associated to this PACS query from the REST API given query search parameters. If no search parameters then get the default first page.

Params:

Name	Type	Attribute	Description
params	Object	optional default: null	page parameters
params.limit	number	optional	page limit
params.offset	number	optional	page offset
searchParams.id	number	optional	match PACS retrieve id exactly with this number
searchParams.min_creation_date	string	optional	match PACS retrieve's creation date gte this date
searchParams.max_creation_date	string	optional	match PACS retrieve's creation date lte this date
searchParams.status	string	optional	match PACS retrieve execution status exactly with this string
searchParams.owner_username	string	optional	match PACS retrieve's owner username exactly with this string
timeout	number	optional default: 30000	request timeout

Return:

Promise<PACSRetrieveList>

JS Promise, resolves to a PACSRetrieveList object

public put(data: Object, timeout: number): Promise<this> source

Make a PUT request to modify this PACS query resource through the REST API.

Params:

Name	Type	Attribute	Description
data	Object		request JSON data object
data.title	string	optional	title of the PACS query
data.description	string	optional	description of the PACS query
timeout	number	optional default: 30000	request timeout

Return:

Promise<this>

JS Promise, resolves to this object