# Modules

# GET GET Modules

# /data-catalog/api/module

# Description

Get list of modules for specified Name or DataSourceId or version. If no parameter value is given, it'll list all the modules otherwise combination of parameter values will be used to filter the list of modules. All the module information except FileData will be fetched. To get the data of file saved in that module other GET api call need to be used.

# Parameters

Name	Located in	Description	Required	Schema
Name	query	Module Name	No	string
DataSourceId	query	Unique mongo DB Id of the connection	No	string
_id	query	Unique mongo Db Id of module	No	string
Version	query	Module Version	No	string

# Responses

Code	Description	Schema
200	Success	Module list json
400	Bad Request. Something wrong with request body.
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Not found. One or more resources were not found
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET GET Module with File Data

# /data-catalog/api/module/fileData/{moduleId}

# Description

Get the complete module information with the contents of the file data for the specidied moduleId.

# Parameters

Name	Located in	Description	Required	Schema
moduleId	query	Unique mongo DB Id of the module	Yes	string

# Responses

Code	Description	Schema
200	Success	Module information json
400	Bad Request. Something wrong with request body.
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Not found. One or more resources were not found
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Create Module

# /data-catalog/api/module

# Description

Creates a new Module with the information provided in the payload. name and dataSourceId are the unique fields in combination. If same Name exist in database, it will not create with that name. BaseSchema validation is performed to check the accepted values for the parameters from list of Enum values.

# Payload

{
  "name": "",
  "dataSourceId": "string",
  "version": 0,
  "description": "string",
  "type": "string",
  "additionalParameters": "string",
  "tags": [
    "string"
  ],
  "createdBy": "string"
}

# Accepted Values (Enums)

Type	Description
Type	"Schema", "Node", "Csv", "Excel"

# Responses

Code	Description	Schema
201	Successfully Created.	Module
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
409	Conflict. Connection with same name/id already exists.
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Update Module

# /data-catalog/api/module

# Description

Updates a module for given moduleName and dataSourceId. BaseSchema validation is performed to check the accepted values for the parameters from list of Enum values.

# Payload

{
  "name": "string",
  "dataSourceId": "string",
  "version": 0,
  "description": "string",
  "type": "string",
  "additionalParameters": "string",
  "tags": [
    "string"
  ],
  "lastModifiedBy": "string"
}

# Accepted Values (Enums)

Type	Description
Type	"Schema", "Node", "Csv", "Excel"

# Responses

Code	Description	Schema
200	Successfully Updated	Module
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Module with given detail is not found
409	Conflict. Module with same name already exists
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Delete Module

# /data-catalog/api/module/{moduleName}/{dataSourceId}

# Description

Deletes the module for the specified parmeters value.

# Parameters

Name	Located in	Description	Required	Schema
moduleName	path	Name of Module	Yes	string
DataSourceId	path	Unique mongo DB Id of the connection	Yes	string
Version	query	Module Version	Yes	string

# Responses

Code	Description	Schema
204	Module successfully deleted
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Module not found for specified parameters
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

← Information Process Metadata →