Class Client

constructor

• new Client(url: string, auth?: { token?: string }): Client

  Constructor

  Parameters

  • url: string

    url of the ChRIS service

  • Optionalauth: { token?: string }

    authentication object

    • Optionaltoken?: string

      authentication token

  Returns Client

adminUrl

auth

chrisInstanceUrl

computeResourcesUrl

downloadTokensUrl

feedsUrl

fileBrowserUrl

groupsUrl

pacsFilesUrl

pacsQueriesUrl

pacsSeriesUrl

pacsUrl

pipelineSourceFilesUrl

pipelinesUrl

pluginInstancesUrl

pluginMetasUrl

pluginsUrl

publicFeedsUrl

tagsUrl

url

userFilesUrl

userUrl

workflowsUrl

_fetchRes

• _fetchRes(
      resUrlProp: string,
      ResClass: string,
      searchParams?: Object,
      timeout?: number,
  ): Promise<any>

  Internal method to fetch a high level resource through the REST API.

  Parameters

  • resUrlProp: string

    property of the this object containing the url of the resource

  • ResClass: string

    resource class

  • OptionalsearchParams: Object

    search parameters object

  • Optionaltimeout: number

    request timeout

  Returns Promise<any>

  • JS Promise

adminCreateGroup

• adminCreateGroup(data: { name: string }, timeout?: number): Promise<Group>

  Create a new group resource through the REST API.

  Parameters

  • data: { name: string }

    request data object

    • name: string

      group name

  • Optionaltimeout: number

    request timeout

  Returns Promise<Group>

  • JS Promise, resolves to a Group object

adminUploadPlugin

• adminUploadPlugin(
      data: { compute_names: string },
      pluginFileObj: { fname: Object },
      timeout?: number,
  ): Promise<PluginAdmin>

  Upload a plugin representation file and create a new plugin admin resource through the REST API.

  Parameters

  • data: { compute_names: string }

    request JSON data object

    • compute_names: string

      string representing a comma-separated list of names of already registered compute resources

  • pluginFileObj: { fname: Object }

    custom file object

    • fname: Object

      plugin's file blob

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginAdmin>

  • JS Promise, resolves to a PluginAdmin object

computeWorkflowNodesInfo

• computeWorkflowNodesInfo(
      pipelineDefaultParameters: Object[],
      includeAllDefaults?: boolean,
  ): Object[]

  Helper method to create the nodes_info field required by createWorkflow method's data argument to create a workflow from a pipeline's default parameters data array typically returned by Pipeline.getDefaultParameters().data.

  Parameters

  • pipelineDefaultParameters: Object[]

    array of objects with the default parameters as returned by Pipeline.getDefaultParameters().data

  • OptionalincludeAllDefaults: boolean

    if set to `true`` then non-null parameters are also included in the result

  Returns Object[]

  • array of workflow node objects

createDownloadToken

• createDownloadToken(timeout?: number): Promise<DownloadToken>

  Create a new file download token resource through the REST API.

  Parameters

  • Optionaltimeout: number

    request timeout

  Returns Promise<DownloadToken>

  • JS Promise, resolves to a DownloadToken object

createFileBrowserFolder

• createFileBrowserFolder(
      data: { path: string },
      timeout?: number,
  ): Promise<FileBrowserFolder>

  Create a new file browser folder resource through the REST API.

  Parameters

  • data: { path: string }

    request data object

    • path: string

      folder path

  • Optionaltimeout: number

    request timeout

  Returns Promise<FileBrowserFolder>

  • JS Promise, resolves to a FileBrowserFolder object

createPACSQuery

• createPACSQuery(
      pacsId: number,
      data: {
          description?: string;
          execute?: boolean;
          query: string;
          title: string;
      },
      timeout?: number,
  ): Promise<PACSQuery>

  Create a new PACS query resource through the REST API.

  Parameters

  • pacsId: number

    PACS id

  • data: { description?: string; execute?: boolean; query: string; title: string }

    request data object

    • Optionaldescription?: string

      PACS query description

    • Optionalexecute?: boolean

      whether to execute the query upon creation

    • query: string

      PACS query JSON string representing a query

    • title: string

      PACS query title

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSQuery>

  • JS Promise, resolves to a PACSQuery object

createPACSRetrieve

• createPACSRetrieve(pacsQueryId: number, timeout?: number): Promise<PACSRetrieve>

  Create a new PACS retrieve resource through the REST API.

  Parameters

  • pacsQueryId: number

    PACS query id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSRetrieve>

  • JS Promise, resolves to a PACSRetrieve object

createPipeline

• createPipeline(
      data: {
          authors?: string;
          category?: string;
          description?: string;
          locked?: boolean;
          name: string;
          plugin_inst_id?: number;
          plugin_tree?: string;
      },
      timeout?: number,
  ): Promise<Pipeline>

  Create a new pipeline resource through the REST API.

  Parameters

  • data: {
        authors?: string;
        category?: string;
        description?: string;
        locked?: boolean;
        name: string;
        plugin_inst_id?: number;
        plugin_tree?: string;
    }

    request data object

    • Optionalauthors?: string

      pipeline authors

    • Optionalcategory?: string

      pipeline category

    • Optionaldescription?: string

      pipeline description

    • Optionallocked?: boolean

      pipeline status

    • name: string

      pipeline name

    • Optionalplugin_inst_id?: number

      plugin instance id

    • Optionalplugin_tree?: string

      JSON string containing a plugin tree list

  • Optionaltimeout: number

    request timeout

  Returns Promise<Pipeline>

  • JS Promise, resolves to a Pipeline object

createPluginInstance

• createPluginInstance(
      pluginId: number,
      data: {
          compute_resource_name?: string;
          cpu_limit?: string;
          gpu_limit?: string;
          memory_limit?: string;
          number_of_workers?: string;
          previous_id: number;
          title?: string;
      },
      timeout?: number,
  ): Promise<PluginInstance>

  Create a new plugin instance resource through the REST API.

  Parameters

  • pluginId: number

    plugin id

  • data: {
        compute_resource_name?: string;
        cpu_limit?: string;
        gpu_limit?: string;
        memory_limit?: string;
        number_of_workers?: string;
        previous_id: number;
        title?: string;
    }

    request data object which is plugin-specific

    • Optionalcompute_resource_name?: string

      remote compute resource name

    • Optionalcpu_limit?: string

      cpu limit

    • Optionalgpu_limit?: string

      gpu limit

    • Optionalmemory_limit?: string

      memory limit

    • Optionalnumber_of_workers?: string

      number of workers

    • previous_id: number

    • Optionaltitle?: string

      title

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginInstance>

  • JS Promise, resolves to a PluginInstance object

createPluginInstanceSplit

• createPluginInstanceSplit(
      pluginInstanceId: number,
      filter?: string,
      cr_name?: string,
      timeout?: number,
  ): Promise<PluginInstanceSplit>

  Create a new plugin instance split resource through the REST API.

  Parameters

  • pluginInstanceId: number

    plugin instance id

  • Optionalfilter: string

    comma-separated list of regular expressions

  • Optionalcr_name: string

    remote compute resource name

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginInstanceSplit>

  • JS Promise, resolves to a PluginInstanceSplit object

createTag

• createTag(
      data: { color: string; name?: string },
      timeout?: number,
  ): Promise<Tag>

  Create a new tag resource through the REST API.

  Parameters

  • data: { color: string; name?: string }

    request data object

    • color: string

      tag color

    • Optionalname?: string

      tag name

  • Optionaltimeout: number

    request timeout

  Returns Promise<Tag>

  • JS Promise, resolves to a Tag object

createWorkflow

• createWorkflow(
      pipelineId: number,
      data: { nodes_info: string; previous_plugin_inst_id: number },
      timeout?: number,
  ): Promise<Workflow>

  Create a new workflow resource through the REST API.

  Parameters

  • pipelineId: number

    pipeline id

  • data: { nodes_info: string; previous_plugin_inst_id: number }

    request data object

    • nodes_info: string

      pipeline-specific JSON string encoding a list of objects. Each object is a workflow node containing a piping_id, compute_resource_name, title, cpu_limit, memory_limit, gpu_limit, number_of_workers and a list of objects called plugin_parameter_defaults. Each object in this list has name and default properties.

    • previous_plugin_inst_id: number

      previous plugin instance id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Workflow>

  • JS Promise, resolves to a Workflow object

getChrisInstance

• getChrisInstance(timeout?: number): Promise<ChrisInstance>

  Get the ChRIS instance resource object.

  Parameters

  • Optionaltimeout: number

    request timeout

  Returns Promise<ChrisInstance>

  • JS Promise, resolves to a ChrisInstance object

getComputeResource

• getComputeResource(
      id: number,
      timeout?: number,
  ): Promise<ComputeResource | null>

  Get a compute resource object given its id.

  Parameters

  • id: number

    compute resource id

  • Optionaltimeout: number

    request timeout

  Returns Promise<ComputeResource | null>

  • JS Promise, resolves to a ComputeResource object or null

getComputeResources

• getComputeResources(
      searchParams?: {
          description?: string;
          id?: number;
          limit?: number;
          name?: string;
          name_exact?: string;
          offset?: number;
          plugin_id?: string;
      },
      timeout?: number,
  ): Promise<ComputeResourceList>

  Get a paginated list of compute resources from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        description?: string;
        id?: number;
        limit?: number;
        name?: string;
        name_exact?: string;
        offset?: number;
        plugin_id?: string;
    }

    search parameters object

    • Optionaldescription?: string

      match compute resource's description containing this string

    • Optionalid?: number

      match file id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalname?: string

      match compute resource's name containing this string

    • Optionalname_exact?: string

      match compute resource's name exactly with this string

    • Optionaloffset?: number

      page offset

    • Optionalplugin_id?: string

      match plugin id exactly with this string for all the compute resources associated with the plugin

  • Optionaltimeout: number

    request timeout

  Returns Promise<ComputeResourceList>

  • JS Promise, resolves to a ComputeResourceList object

getDownloadToken

• getDownloadToken(id: number, timeout?: number): Promise<DownloadToken | null>

  Get a download token resource object given its id.

  Parameters

  • id: number

    file download token id

  • Optionaltimeout: number

    request timeout

  Returns Promise<DownloadToken | null>

  • JS Promise, resolves to a DownloadToken object or null

getDownloadTokens

• getDownloadTokens(
      searchParams?: { id?: number; limit?: number; offset?: number },
      timeout?: number,
  ): Promise<DownloadTokenList>

  Get a paginated list of file download tokens for the authenticated user from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: { id?: number; limit?: number; offset?: number }

    search parameters object

    • Optionalid?: number

      match file download token id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionaloffset?: number

      page offset

  • Optionaltimeout: number

    request timeout

  Returns Promise<DownloadTokenList>

  • JS Promise, resolves to a DownloadTokenList object

getFeed

• getFeed(id: number, timeout?: number): Promise<Feed | null>

  Get a feed resource object given its id.

  Parameters

  • id: number

    feed id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Feed | null>

  • JS Promise, resolves to a Feed object or null

getFeeds

• getFeeds(
      searchParams?: {
          files_fname_icontains?: string;
          id?: number;
          limit?: number;
          max_creation_date?: number;
          max_id?: number;
          min_creation_date?: number;
          min_id?: number;
          name?: string;
          name_exact?: string;
          name_startswith?: string;
          offset?: number;
      },
      timeout?: number,
  ): Promise<FeedList>

  Get a paginated list of currently authenticated user's feeds from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        files_fname_icontains?: string;
        id?: number;
        limit?: number;
        max_creation_date?: number;
        max_id?: number;
        min_creation_date?: number;
        min_id?: number;
        name?: string;
        name_exact?: string;
        name_startswith?: string;
        offset?: number;
    }

    search parameters object

    • Optionalfiles_fname_icontains?: string

      match the feeds that have files containing all the substrings from the queried string (which in turn represents a white-space-separated list of query strings) case insensitive anywhere in their fname.

    • Optionalid?: number

      match feed id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: number

      match feed creation date lte this date

    • Optionalmax_id?: number

      match feed id lte this number

    • Optionalmin_creation_date?: number

      match feed creation date gte this date

    • Optionalmin_id?: number

      match feed id gte this number

    • Optionalname?: string

      match feed name containing this string

    • Optionalname_exact?: string

      match feed name exactly with this string

    • Optionalname_startswith?: string

      match feed name starting with this string

    • Optionaloffset?: number

      page offset

  • Optionaltimeout: number

    request timeout

  Returns Promise<FeedList>

  • JS Promise, resolves to a FeedList object

getFileBrowserFolder

• getFileBrowserFolder(
      id: number,
      timeout?: number,
  ): Promise<FileBrowserFolder | null>

  Get a file browser folder resource object given its id.

  Parameters

  • id: number

    file browser folder id

  • Optionaltimeout: number

    request timeout

  Returns Promise<FileBrowserFolder | null>

  • JS Promise, resolves to a FileBrowserFolder object or null

getFileBrowserFolderByPath

• getFileBrowserFolderByPath(
      path?: string,
      timeout?: number,
  ): Promise<FileBrowserFolder | null>

  Get a file browser folder resource object given its path.

  Parameters

  • Optionalpath: string

    file browser folder path

  • Optionaltimeout: number

    request timeout

  Returns Promise<FileBrowserFolder | null>

  • JS Promise, resolves to a FileBrowserFolder object or null

getFileBrowserFolders

• getFileBrowserFolders(
      searchParams?: {
          id?: number;
          limit?: number;
          offset?: number;
          path?: string;
      },
      timeout?: number,
  ): Promise<FileBrowserFolderList>

  Get a list with the matching file browser folder (the returned list only has at most one element) from the REST API given query search parameters. If no search parameters then get a list with the default root folder.

  Parameters

  • OptionalsearchParams: { id?: number; limit?: number; offset?: number; path?: string }

    search parameters object

    • Optionalid?: number

      match folder id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionaloffset?: number

      page offset

    • Optionalpath?: string

      match folder's path exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<FileBrowserFolderList>

  • JS Promise, resolves to a FileBrowserFolderList object

getGroup

• getGroup(id: number, timeout?: number): Promise<Group | null>

  Get a group resource object given its id.

  Parameters

  • id: number

    group id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Group | null>

  • JS Promise, resolves to a Group object or null

getGroups

• getGroups(
      searchParams?: {
          id?: number;
          limit?: number;
          name?: string;
          name_icontains?: string;
          offset?: number;
      },
      timeout?: number,
  ): Promise<GroupList>

  Get a paginated list of groups from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        id?: number;
        limit?: number;
        name?: string;
        name_icontains?: string;
        offset?: number;
    }

    search parameters object

    • Optionalid?: number

      match group id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalname?: string

      match group name exactly with this string

    • Optionalname_icontains?: string

      match group name containing this string

    • Optionaloffset?: number

      page offset

  • Optionaltimeout: number

    request timeout

  Returns Promise<GroupList>

  • JS Promise, resolves to a GroupList object

getPACS

• getPACS(id: number, timeout?: number): Promise<PACS | null>

  Get a PACS resource object given its id.

  Parameters

  • id: number

    PACS id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACS | null>

  • JS Promise, resolves to a PACS object or null

getPACSFile

• getPACSFile(id: number, timeout?: number): Promise<PACSFile | null>

  Get a PACS file resource object given its id.

  Parameters

  • id: number

    PACS file id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSFile | null>

  • JS Promise, resolves to a PACSFile object or ``null`

getPACSFiles

• getPACSFiles(
      searchParams?: {
          fname?: string;
          fname_exact?: string;
          fname_icontains?: string;
          fname_icontains_topdir_unique?: string;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          min_creation_date?: string;
          offset?: number;
      },
      timeout?: number,
  ): Promise<PACSFileList>

  Get a paginated list of PACS files from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        fname?: string;
        fname_exact?: string;
        fname_icontains?: string;
        fname_icontains_topdir_unique?: string;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        min_creation_date?: string;
        offset?: number;
    }

    search parameters object

    • Optionalfname?: string

      match file's path starting with this string

    • Optionalfname_exact?: string

      match file's path exactly with this string

    • Optionalfname_icontains?: string

      match file's path containing this string

    • Optionalfname_icontains_topdir_unique?: string

      match file's path containing all the substrings from the queried string (which in turn represents a white-space-separated list of query strings) case insensitive anywhere in their fname. But only one file is returned per toplevel directory under SERVICES/PACS/pacs_name. This is useful to efficiently determine the top level directories containing a file that matches the query.

    • Optionalid?: number

      match file id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match file's creation_date lesser than this date string

    • Optionalmin_creation_date?: string

      match file's creation_date greater than this date string

    • Optionaloffset?: number

      page offset

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSFileList>

  • JS Promise, resolves to a PACSFileList object

getPACSList

• getPACSList(
      searchParams?: {
          active?: boolean;
          id?: number;
          identifier?: string;
          limit?: number;
          offset?: number;
      },
      timeout?: number,
  ): Promise<PACSList>

  Get a paginated PACS list from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        active?: boolean;
        id?: number;
        identifier?: string;
        limit?: number;
        offset?: number;
    }

    search parameters object

    • Optionalactive?: boolean

      match PACS active status with this boolean

    • Optionalid?: number

      match PACS id exactly with this number

    • Optionalidentifier?: string

      match PACS identifier exactly with this string

    • Optionallimit?: number

      page limit

    • Optionaloffset?: number

      page offset

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSList>

  • JS Promise, resolves to a PACSList object

getPACSQueries

• getPACSQueries(
      searchParams?: {
          description?: string;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          min_creation_date?: string;
          offset?: number;
          owner_username?: string;
          pacs_id?: number;
          pacs_identifier?: string;
          status?: string;
          title?: string;
          title_exact?: string;
      },
      timeout?: number,
  ): Promise<AllPACSQueryList>

  Get a paginated list of PACS queries from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        description?: string;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        min_creation_date?: string;
        offset?: number;
        owner_username?: string;
        pacs_id?: number;
        pacs_identifier?: string;
        status?: string;
        title?: string;
        title_exact?: string;
    }

    search parameters object

    • Optionaldescription?: string

      match PACS query description containing this string

    • Optionalid?: number

      match PACS query id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match PACS query's creation date lte this date

    • Optionalmin_creation_date?: string

      match PACS query's creation date gte this date

    • Optionaloffset?: number

      page offset

    • Optionalowner_username?: string

      match PACS query's owner username exactly with this string

    • Optionalpacs_id?: number

      match related PACS's id exactly with this number

    • Optionalpacs_identifier?: string

      match related PACS's identifier exactly with this string

    • Optionalstatus?: string

      match PACS query execution status exactly with this string

    • Optionaltitle?: string

      match PACS query title containing this string

    • Optionaltitle_exact?: string

      match PACS query title exactly this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<AllPACSQueryList>

  • JS Promise, resolves to AllPACSQueryList object

getPACSQuery

• getPACSQuery(id: number, timeout?: number): Promise<PACSQuery | null>

  Get a PACS query resource object given its id.

  Parameters

  • id: number

    PACS query id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSQuery | null>

  • JS Promise, resolves to a PACSQuery object or null

getPACSSeries

• getPACSSeries(id: number, timeout?: number): Promise<PACSSeries | null>

  Get a PACS series resource object given its id.

  Parameters

  • id: number

    PACS series id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSSeries | null>

  • JS Promise, resolves to a PACSSeries object or null

getPACSSeriesList

• getPACSSeriesList(
      searchParams?: {
          AccessionNumber?: string;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          max_PatientAge?: number;
          min_creation_date?: string;
          min_PatientAge?: number;
          offset?: number;
          pacs_identifier?: string;
          PatientAge?: number;
          PatientBirthDate?: string;
          PatientID?: string;
          PatientName?: string;
          PatientSex?: string;
          ProtocolName?: string;
          SeriesDescription?: string;
          SeriesInstanceUID?: string;
          StudyDate?: string;
          StudyDescription?: string;
          StudyInstanceUID?: string;
      },
      timeout?: number,
  ): Promise<PACSSeriesList>

  Get a paginated list of PACS series from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        AccessionNumber?: string;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        max_PatientAge?: number;
        min_creation_date?: string;
        min_PatientAge?: number;
        offset?: number;
        pacs_identifier?: string;
        PatientAge?: number;
        PatientBirthDate?: string;
        PatientID?: string;
        PatientName?: string;
        PatientSex?: string;
        ProtocolName?: string;
        SeriesDescription?: string;
        SeriesInstanceUID?: string;
        StudyDate?: string;
        StudyDescription?: string;
        StudyInstanceUID?: string;
    }

    search parameters object

    • OptionalAccessionNumber?: string

      match PACS series' AccessionNumber exactly with this string

    • Optionalid?: number

      match PACS series' id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match PACS series' creation_date lesser than this date string

    • Optionalmax_PatientAge?: number

      match PACS series' PatientAge lesser than this number

    • Optionalmin_creation_date?: string

      match PACS series' creation_date greater than this date string

    • Optionalmin_PatientAge?: number

      match PACS series' PatientAge greater than this number

    • Optionaloffset?: number

      page offset

    • Optionalpacs_identifier?: string

      match PACS series' PACS exactly with this string

    • OptionalPatientAge?: number

      match PACS series' PatientAge exactly with this number

    • OptionalPatientBirthDate?: string

      match PACS series' PatientBirthDate exactly with this date string

    • OptionalPatientID?: string

      match PACS series' PatientID exactly with this string

    • OptionalPatientName?: string

      match PACS series' PatientName containing this string

    • OptionalPatientSex?: string

      match PACS series' PatientSex exactly with this string

    • OptionalProtocolName?: string

      match PACS series' ProtocolName exactly with this string

    • OptionalSeriesDescription?: string

      match PACS series' SeriesDescription containing this string

    • OptionalSeriesInstanceUID?: string

      match PACS series' SeriesInstanceUID exactly with this string

    • OptionalStudyDate?: string

      match PACS series' StudyDate exactly with this date string

    • OptionalStudyDescription?: string

      match PACS series' StudyDescription containing this string

    • OptionalStudyInstanceUID?: string

      match PACS series' StudyInstanceUID exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<PACSSeriesList>

  • JS Promise, resolves to a PACSSeriesList object

getPipeline

• getPipeline(id: number, timeout?: number): Promise<Pipeline | null>

  Get a pipeline resource object given its id.

  Parameters

  • id: number

    pipeline id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Pipeline | null>

  • JS Promise, resolves to a Pipeline object or null

getPipelines

• getPipelines(
      searchParams?: {
          authors?: string;
          category?: string;
          description?: string;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          min_creation_date?: string;
          name?: string;
          name_exact?: string;
          offset?: number;
          owner_username?: string;
      },
      timeout?: number,
  ): Promise<PipelineList>

  Get a paginated list of pipelines from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        authors?: string;
        category?: string;
        description?: string;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        min_creation_date?: string;
        name?: string;
        name_exact?: string;
        offset?: number;
        owner_username?: string;
    }

    search parameters object

    • Optionalauthors?: string

      match pipeline authors containing this string

    • Optionalcategory?: string

      match pipeline category containing this string

    • Optionaldescription?: string

      match pipeline description containing this string

    • Optionalid?: number

      match pipeline id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match pipeline creation date lte this date

    • Optionalmin_creation_date?: string

      match pipeline creation date gte this date

    • Optionalname?: string

      match pipeline name containing this string

    • Optionalname_exact?: string

      match pipeline name exactly with this string

    • Optionaloffset?: number

      page offset

    • Optionalowner_username?: string

      match pipeline's owner username exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<PipelineList>

  • JS Promise, resolves to a PipelineList object

getPipelineSourceFile

• getPipelineSourceFile(
      id: number,
      timeout?: number,
  ): Promise<PipelineSourceFile | null>

  Get a pipeline source file resource object given its id.

  Parameters

  • id: number

    pipeline source file id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PipelineSourceFile | null>

  • JS Promise, resolves to a PipelineSourceFile object or ``null`

getPipelineSourceFiles

• getPipelineSourceFiles(
      searchParams?: {
          fname?: string;
          fname_exact?: string;
          fname_icontains?: string;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          min_creation_date?: string;
          offset?: number;
          pipeline_id?: number;
          pipeline_name?: string;
          uploader_username?: string;
      },
      timeout?: number,
  ): Promise<PipelineSourceFileList>

  Get a paginated list of pipeline source files from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        fname?: string;
        fname_exact?: string;
        fname_icontains?: string;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        min_creation_date?: string;
        offset?: number;
        pipeline_id?: number;
        pipeline_name?: string;
        uploader_username?: string;
    }

    search parameters object

    • Optionalfname?: string

      match file's path starting with this string

    • Optionalfname_exact?: string

      match file's path exactly with this string

    • Optionalfname_icontains?: string

      match file's path containing this string

    • Optionalid?: number

      match file id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match file's creation_date lesser than this date string

    • Optionalmin_creation_date?: string

      match file's creation_date greater than this date string

    • Optionaloffset?: number

      page offset

    • Optionalpipeline_id?: number

      match file's pipeline id exactly with this number

    • Optionalpipeline_name?: string

      match file's pipeline name exactly with this string

    • Optionaluploader_username?: string

      match file's uploader username exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<PipelineSourceFileList>

  • JS Promise, resolves to a PipelineSourceFileList object

getPlugin

• getPlugin(id: number, timeout?: number): Promise<Plugin | null>

  Get a plugin resource object given its id.

  Parameters

  • id: number

    plugin id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Plugin | null>

  • JS Promise, resolves to a Plugin object or null

getPluginInstance

• getPluginInstance(id: number, timeout?: number): Promise<PluginInstance | null>

  Get a plugin instance resource object given its id.

  Parameters

  • id: number

    plugin instance id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginInstance | null>

  • JS Promise, resolves to a PluginInstance object or null

getPluginInstances

• getPluginInstances(
      searchParams?: {
          active?: boolean;
          feed_id?: number;
          id?: number;
          limit?: number;
          max_end_date?: string;
          max_start_date?: string;
          min_end_date?: string;
          min_start_date?: string;
          offset?: number;
          owner_username?: string;
          plugin_id?: number;
          plugin_name?: number;
          plugin_name_exact?: number;
          plugin_type?: string;
          plugin_version?: number;
          previous_id?: number;
          root_id?: number;
          status?: string;
          title?: string;
          workflow_id?: number;
      },
      timeout?: number,
  ): Promise<AllPluginInstanceList>

  Get a paginated list of plugin instances from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        active?: boolean;
        feed_id?: number;
        id?: number;
        limit?: number;
        max_end_date?: string;
        max_start_date?: string;
        min_end_date?: string;
        min_start_date?: string;
        offset?: number;
        owner_username?: string;
        plugin_id?: number;
        plugin_name?: number;
        plugin_name_exact?: number;
        plugin_type?: string;
        plugin_version?: number;
        previous_id?: number;
        root_id?: number;
        status?: string;
        title?: string;
        workflow_id?: number;
    }

    search parameters object

    • Optionalactive?: boolean

      match plugin instance active status exactly with this boolean

    • Optionalfeed_id?: number

      match associated feed's id exactly with this number

    • Optionalid?: number

      match plugin instance id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_end_date?: string

      match plugin instance's end date lte this date

    • Optionalmax_start_date?: string

      match plugin instance's start date lte this date

    • Optionalmin_end_date?: string

      match plugin instance's end date gte this date

    • Optionalmin_start_date?: string

      match plugin instance's start date gte this date

    • Optionaloffset?: number

      page offset

    • Optionalowner_username?: string

      match plugin instances's owner username exactly with this string

    • Optionalplugin_id?: number

      match associated plugin's id exactly with this number

    • Optionalplugin_name?: number

      match associated plugin's name containing this string

    • Optionalplugin_name_exact?: number

      match associated plugin's name exact with this string

    • Optionalplugin_type?: string

      match plugin type exactly with this string

    • Optionalplugin_version?: number

      match associated plugin's version exactly with this string

    • Optionalprevious_id?: number

      match previous plugin instance's id exactly with this number

    • Optionalroot_id?: number

      match root plugin instance's id exactly with this number

    • Optionalstatus?: string

      match plugin instance execution status exactly with this string

    • Optionaltitle?: string

      match plugin instance title containing this string

    • Optionalworkflow_id?: number

      match associated workflows's id exactly with this number

  • Optionaltimeout: number

    request timeout

  Returns Promise<AllPluginInstanceList>

  • JS Promise, resolves to AllPluginInstanceList object

getPluginMeta

• getPluginMeta(id: number, timeout?: number): Promise<PluginMeta | null>

  Get a plugin meta resource object given its id.

  Parameters

  • id: number

    plugin meta id

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginMeta | null>

  • JS Promise, resolves to a PluginMeta object or null

getPluginMetas

• getPluginMetas(
      searchParams?: {
          authors?: string;
          category?: string;
          id?: number;
          limit?: number;
          max_creation_date?: number;
          min_creation_date?: number;
          name?: string;
          name_authors_category?: string;
          name_exact?: string;
          name_title_category?: string;
          offset?: number;
          title?: string;
          type?: string;
      },
      timeout?: number,
  ): Promise<PluginMetaList>

  Get a paginated list of plugin metas from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        authors?: string;
        category?: string;
        id?: number;
        limit?: number;
        max_creation_date?: number;
        min_creation_date?: number;
        name?: string;
        name_authors_category?: string;
        name_exact?: string;
        name_title_category?: string;
        offset?: number;
        title?: string;
        type?: string;
    }

    search parameters object

    • Optionalauthors?: string

      match plugin meta authors containing this string

    • Optionalcategory?: string

      match plugin meta category exactly with this string

    • Optionalid?: number

      match plugin meta id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: number

      match plugin meta creation date lte this date

    • Optionalmin_creation_date?: number

      match plugin meta creation date gte this date

    • Optionalname?: string

      match plugin meta name containing this string

    • Optionalname_authors_category?: string

      match plugin meta name, authors or category containing this string

    • Optionalname_exact?: string

      match plugin meta name exactly with this string

    • Optionalname_title_category?: string

      match plugin meta name, title or category containing this string

    • Optionaloffset?: number

      page offset

    • Optionaltitle?: string

      match plugin meta title containing this string

    • Optionaltype?: string

      match plugin meta type exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginMetaList>

  • JS Promise, resolves to a PluginMetaList object

getPlugins

• getPlugins(
      searchParams?: {
          category?: string;
          compute_resource_id?: number;
          description?: string;
          dock_image?: string;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          min_creation_date?: string;
          name?: string;
          name_exact?: string;
          name_title_category?: string;
          offset?: number;
          title?: string;
          type?: string;
          version?: string;
      },
      timeout?: number,
  ): Promise<PluginList>

  Get a paginated list of plugins from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        category?: string;
        compute_resource_id?: number;
        description?: string;
        dock_image?: string;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        min_creation_date?: string;
        name?: string;
        name_exact?: string;
        name_title_category?: string;
        offset?: number;
        title?: string;
        type?: string;
        version?: string;
    }

    search parameters object

    • Optionalcategory?: string

      match plugin category containing this string

    • Optionalcompute_resource_id?: number

      match plugin's compute resource id exactly with this number

    • Optionaldescription?: string

      match plugin description containing this string

    • Optionaldock_image?: string

      match plugin docker image exactly with this string

    • Optionalid?: number

      match plugin id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match plugin creation date lte this date

    • Optionalmin_creation_date?: string

      match plugin creation date gte this date

    • Optionalname?: string

      match plugin name containing this string

    • Optionalname_exact?: string

      match plugin name exactly with this string

    • Optionalname_title_category?: string

      match plugin name, title or category containing this string

    • Optionaloffset?: number

      page offset

    • Optionaltitle?: string

      match plugin title containing this string

    • Optionaltype?: string

      match plugin type exactly with this string

    • Optionalversion?: string

      match plugin version exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<PluginList>

  • JS Promise, resolves to a PluginList object

getPublicFeeds

• getPublicFeeds(
      searchParams?: {
          files_fname_icontains?: string;
          id?: number;
          limit?: number;
          max_creation_date?: number;
          max_id?: number;
          min_creation_date?: number;
          min_id?: number;
          name?: string;
          name_exact?: string;
          name_startswith?: string;
          offset?: number;
      },
      timeout?: number,
  ): Promise<PublicFeedList>

  Get a paginated list of public feeds from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        files_fname_icontains?: string;
        id?: number;
        limit?: number;
        max_creation_date?: number;
        max_id?: number;
        min_creation_date?: number;
        min_id?: number;
        name?: string;
        name_exact?: string;
        name_startswith?: string;
        offset?: number;
    }

    search parameters object

    • Optionalfiles_fname_icontains?: string

      match the feeds that have files containing all the substrings from the queried string (which in turn represents a white-space-separated list of query strings) case insensitive anywhere in their fname.

    • Optionalid?: number

      match feed id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: number

      match feed creation date lte this date

    • Optionalmax_id?: number

      match feed id lte this number

    • Optionalmin_creation_date?: number

      match feed creation date gte this date

    • Optionalmin_id?: number

      match feed id gte this number

    • Optionalname?: string

      match feed name containing this string

    • Optionalname_exact?: string

      match feed name exactly with this string

    • Optionalname_startswith?: string

      match feed name starting with this string

    • Optionaloffset?: number

      page offset

  • Optionaltimeout: number

    request timeout

  Returns Promise<PublicFeedList>

  • JS Promise, resolves to a PublicFeedList object

getTag

• getTag(id: number, timeout?: number): Promise<Tag | null>

  Get a tag resource object given its id.

  Parameters

  • id: number

    tag id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Tag | null>

  • JS Promise, resolves to a Tag object or null

getTags

• getTags(
      searchParams?: {
          color?: string;
          id?: number;
          limit?: number;
          name?: string;
          offset?: number;
          owner_username?: string;
      },
      timeout?: number,
  ): Promise<TagList>

  Get a paginated list of tags from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        color?: string;
        id?: number;
        limit?: number;
        name?: string;
        offset?: number;
        owner_username?: string;
    }

    search parameters object

    • Optionalcolor?: string

      match plugin color containing this string

    • Optionalid?: number

      match tag id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalname?: string

      match tag name containing this string

    • Optionaloffset?: number

      page offset

    • Optionalowner_username?: string

      match tag's owner username exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<TagList>

  • JS Promise, resolves to a TagList object

getUser

• getUser(timeout?: number): Promise<User>

  Get a user resource object for the currently authenticated user.

  Parameters

  • Optionaltimeout: number

    request timeout

  Returns Promise<User>

  • JS Promise, resolves to a User object

getUserFile

• getUserFile(id: number, timeout?: number): Promise<UserFile | null>

  Get a user file resource object given its id.

  Parameters

  • id: number

    user file id

  • Optionaltimeout: number

    request timeout

  Returns Promise<UserFile | null>

  • JS Promise, resolves to a UserFile object or null

getUserFiles

• getUserFiles(
      searchParams?: {
          fname?: string;
          fname_exact?: string;
          fname_icontains?: string;
          fname_nslashes?: string | number;
          id?: number;
          limit?: number;
          max_creation_date?: string;
          min_creation_date?: string;
          offset?: number;
          owner_username?: string;
      },
      timeout?: number,
  ): Promise<UserFileList>

  Get a paginated list of user files from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        fname?: string;
        fname_exact?: string;
        fname_icontains?: string;
        fname_nslashes?: string | number;
        id?: number;
        limit?: number;
        max_creation_date?: string;
        min_creation_date?: string;
        offset?: number;
        owner_username?: string;
    }

    search parameters object

    • Optionalfname?: string

      match file's path starting with this string

    • Optionalfname_exact?: string

      match file's path exactly with this string

    • Optionalfname_icontains?: string

      match file's path containing this string

    • Optionalfname_nslashes?: string | number

      match file's path containing this number of slashes

    • Optionalid?: number

      match file id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionalmax_creation_date?: string

      match file's creation_date lesser than this date string

    • Optionalmin_creation_date?: string

      match file's creation_date greater than this date string

    • Optionaloffset?: number

      page offset

    • Optionalowner_username?: string

      match file's owner username exactly with this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<UserFileList>

  • JS Promise, resolves to a UserFileList object

getWorkflow

• getWorkflow(id: number, timeout?: number): Promise<Workflow> | null

  Get a workflow resource object given its id.

  Parameters

  • id: number

    workflow id

  • Optionaltimeout: number

    request timeout

  Returns Promise<Workflow> | null

  • JS Promise, resolves to a Workflow object or null

getWorkflows

• getWorkflows(
      searchParams?: {
          id?: number;
          limit?: number;
          offset?: number;
          owner_username?: string;
          pipeline_name?: string;
          title?: string;
      },
      timeout?: number,
  ): Promise<AllWorkflowList>

  Get a paginated list of workflows from the REST API given query search parameters. If no search parameters then get the default first page.

  Parameters

  • OptionalsearchParams: {
        id?: number;
        limit?: number;
        offset?: number;
        owner_username?: string;
        pipeline_name?: string;
        title?: string;
    }

    search parameters object

    • Optionalid?: number

      match workflow id exactly with this number

    • Optionallimit?: number

      page limit

    • Optionaloffset?: number

      page offset

    • Optionalowner_username?: string

      match workflow's owner username exactly with this string

    • Optionalpipeline_name?: string

      match associated pipeline name containing this string

    • Optionaltitle?: string

      match workflow title containing this string

  • Optionaltimeout: number

    request timeout

  Returns Promise<AllWorkflowList>

  • JS Promise, resolves to AllWorkflowList object

setUrls

• setUrls(timeout?: number): Promise<any>

  Set the urls of the high level API resources.

  Parameters

  • Optionaltimeout: number

    request timeout

  Returns Promise<any>

  • JS Promise

uploadFile

• uploadFile(
      data: { upload_path: string },
      uploadFileObj: { fname: Object },
      timeout?: number,
  ): Promise<UserFile>

  Upload a file and create a new user file resource through the REST API.

  Parameters

  • data: { upload_path: string }

    request data object

    • upload_path: string

      absolute path including file name where the file will be uploaded on the storage service

  • uploadFileObj: { fname: Object }

    custom file object

    • fname: Object

      file blob

  • Optionaltimeout: number

    request timeout

  Returns Promise<UserFile>

  • JS Promise, resolves to a UserFile object

uploadPipelineSourceFile

• uploadPipelineSourceFile(
      data: { type: string },
      uploadFileObj: { fname: Object },
      timeout?: number,
  ): Promise<PipelineSourceFile>

  Upload a pipeline source file and create a new pipeline source file resource through the REST API. In addition, this creates a new pipeline resource based on the source of the uploaded file.

  Parameters

  • data: { type: string }

    request data object

    • type: string

      pipeline source file type

  • uploadFileObj: { fname: Object }

    custom file object

    • fname: Object

      file blob

  • Optionaltimeout: number

    request timeout

  Returns Promise<PipelineSourceFile>

  • JS Promise, resolves to a PipelineSourceFile object