FileManagementService

Upload or download files within Symitar.

Symitar eDocs References: Coming soon.

Operations

downloadLetterFile

post

Downloads a letter file.

Authorizations

Body

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/downloadLetterFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "Data": null,
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

uploadLetterFile

post

Uploads a letter file.

Authorizations

Body

FileNamestringOptional

The name of the file to be uploaded or downloaded

Database64BinaryOptional

The data to be uploaded or downloaded.

noNewlinebooleanOptional

Whether to include newline characters in the file

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/uploadLetterFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "Data": null,
  "noNewline": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

deleteLetterFile

post

Deletes a letter file.

Authorizations

Body

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/deleteLetterFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  }
}

uploadDataFile

post

Uploads a data file.

Authorizations

Body

FileNamestringOptional

The name of the file to be uploaded or downloaded

Database64BinaryOptional

The data to be uploaded or downloaded.

noNewlinebooleanOptional

Whether to include newline characters in the file

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/uploadDataFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "Data": null,
  "noNewline": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

downloadDataFile

post

Downloads a data file.

Authorizations

Body

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/downloadDataFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "Data": null,
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

deleteDataFile

post

Deletes a data file.

Authorizations

Body

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/deleteDataFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  }
}