# Schemas

## Schemas

### InvokeCloudFnRequestBody <a href="#tocs_invokecloudfnrequestbody" id="tocs_invokecloudfnrequestbody"></a>

```json
{
  "functionName": "string",
  "moduleName": "string",
  "argumentValues": {
    "property1": "string",
    "property2": "string"
  },
  "argumentTypes": {
    "property1": "string",
    "property2": "string"
  },
  "returnType": "string"
}

```

#### Properties

| Name                       | Type   | Required | Restrictions | Description                 |
| -------------------------- | ------ | -------- | ------------ | --------------------------- |
| functionName               | string | false    | none         | Name of the function        |
| moduleName                 | string | false    | none         | Name of the python module   |
| argumentValues             | object | false    | none         | Array of arguments          |
| » **additionalProperties** | string | false    | none         | none                        |
| argumentTypes              | object | false    | none         | Map of argument types       |
| » **additionalProperties** | string | false    | none         | none                        |
| returnType                 | string | false    | none         | Return type of the function |

### InvokeCloudFnResponseBody <a href="#tocs_invokecloudfnresponsebody" id="tocs_invokecloudfnresponsebody"></a>

```json
{
  "result": {}
}

```

#### Properties

| Name   | Type   | Required | Restrictions | Description                                                        |
| ------ | ------ | -------- | ------------ | ------------------------------------------------------------------ |
| result | object | false    | none         | Key value pair or responses that the cloud funciton will return it |

### File <a href="#tocs_file" id="tocs_file"></a>

```json
{
  "createdAt": "2000-01-23T04:56:07.000Z",
  "fileName": "fileName",
  "metadata": {},
  "fileSize": 6,
  "fileURI": "fileURI",
  "id": 0
}

```

#### Properties

| Name      | Type              | Required | Restrictions | Description                                              |
| --------- | ----------------- | -------- | ------------ | -------------------------------------------------------- |
| id        | integer           | false    | none         | Unique id of the file object                             |
| fileName  | string            | false    | none         | Name of file                                             |
| fileURI   | string¦null       | false    | none         | URI of the file                                          |
| fileSize  | integer           | false    | none         | Size of the file in bytes                                |
| createdAt | string(date-time) | false    | none         | Time when the file object was created                    |
| metadata  | object¦null       | false    | none         | Optional metadata associated with the file (JSON format) |

### taskResponse <a href="#tocs_taskresponse" id="tocs_taskresponse"></a>

```json
{
  "createdAt": "2000-01-23T04:56:07.000Z",
  "queueId": 6,
  "completedAt": "2000-01-23T04:56:07.000Z",
  "payload": "payload",
  "startedAt": "2000-01-23T04:56:07.000Z",
  "id": 0,
  "status": "TO_DO"
}

```

#### Properties

| Name        | Type              | Required | Restrictions | Description                   |
| ----------- | ----------------- | -------- | ------------ | ----------------------------- |
| id          | integer(int64)    | false    | none         | Unique ID of the task         |
| status      | string            | false    | none         | Current status of task        |
| createdAt   | string(date-time) | false    | none         | Task creation time-date       |
| startedAt   | string(date-time) | false    | none         | task starting time            |
| completedAt | string(date-time) | false    | none         | task completion time-date     |
| payload     | string            | false    | none         | data regarding task           |
| queueId     | integer(int64)    | false    | none         | queueID to which task belongs |

**Enumerated Values**

| Property | Value        |
| -------- | ------------ |
| status   | TO\_DO       |
| status   | IN\_PROGRESS |
| status   | DONE         |

### taskUpdateRequest <a href="#tocs_taskupdaterequest" id="tocs_taskupdaterequest"></a>

```json
{
  "status": "T0_D0"
}

```

#### Properties

| Name   | Type   | Required | Restrictions | Description            |
| ------ | ------ | -------- | ------------ | ---------------------- |
| status | string | false    | none         | Current status of task |

**Enumerated Values**

| Property | Value        |
| -------- | ------------ |
| status   | TO\_DO       |
| status   | IN\_PROGRESS |
| status   | DONE         |

### addTaskToqueueRequest <a href="#tocs_addtasktoqueuerequest" id="tocs_addtasktoqueuerequest"></a>

```json
{
  "queueName": "patient",
  "payload": "payload"
}

```

#### Properties

| Name      | Type   | Required | Restrictions | Description                     |
| --------- | ------ | -------- | ------------ | ------------------------------- |
| payload   | string | false    | none         | data regarding task             |
| queueName | string | false    | none         | queuename to which task belongs |

### queueResponse <a href="#tocs_queueresponse" id="tocs_queueresponse"></a>

```json
{
  "queueName": "queueName",
  "id": 0,
  "createdAt": "2000-01-23T04:56:07.000Z"
}

```

#### Properties

| Name      | Type              | Required | Restrictions | Description             |
| --------- | ----------------- | -------- | ------------ | ----------------------- |
| id        | integer(int64)    | false    | none         | Unique id of the queue  |
| queueName | string            | false    | none         | Name of the queue       |
| createdAt | string(date-time) | false    | none         | Task creation time-date |

### ApiResponse <a href="#tocs_apiresponse" id="tocs_apiresponse"></a>

```json
{
  "code": 0,
  "type": "type",
  "message": "message"
}

```

#### Properties

| Name    | Type           | Required | Restrictions | Description |
| ------- | -------------- | -------- | ------------ | ----------- |
| code    | integer(int32) | false    | none         | none        |
| type    | string         | false    | none         | none        |
| message | string         | false    | none         | none        |

### queueNameRequest <a href="#tocs_queuenamerequest" id="tocs_queuenamerequest"></a>

```json
{
  "queueName": "string"
}

```

#### Properties

| Name      | Type   | Required | Restrictions | Description       |
| --------- | ------ | -------- | ------------ | ----------------- |
| queueName | string | false    | none         | Name of the queue |

### inlineResponse200 <a href="#tocs_inlineresponse200" id="tocs_inlineresponse200"></a>

```json
{
  "taskID": "taskID"
}

```

#### Properties

| Name   | Type   | Required | Restrictions | Description               |
| ------ | ------ | -------- | ------------ | ------------------------- |
| taskID | string | false    | none         | ID of the task from queue |

### taskStatus <a href="#tocs_taskstatus" id="tocs_taskstatus"></a>

```json
{
  "status": "status"
}

```