FileManagementService

Upload or download files within Symitar.

Symitar eDocs References: Coming soon.

Operations

downloadLetterFile

post

Downloads a letter file.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

/downloadLetterFile

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/downloadLetterFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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": 1,
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

uploadLetterFile

post

Uploads a letter file.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FileNamestringOptional

The name of the file to be uploaded or downloaded

DatanumberOptional

The data to be uploaded or downloaded.

noNewlinebooleanOptional

Whether to include newline characters in the file

Responses

200

Successful operation.

application/json

post

/uploadLetterFile

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "Data": 1,
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

/deleteLetterFile

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/deleteLetterFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FileNamestringOptional

The name of the file to be uploaded or downloaded

DatanumberOptional

The data to be uploaded or downloaded.

noNewlinebooleanOptional

Whether to include newline characters in the file

Responses

200

Successful operation.

application/json

post

/uploadDataFile

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "FileName": "text",
  "Data": 1,
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

/downloadDataFile

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/downloadDataFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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": 1,
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

deleteDataFile

post

Deletes a data file.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FileNamestringRequired

The name of the file to be uploaded or downloaded

Responses

200

Successful operation.

application/json

post

/deleteDataFile

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/filemanagement/deleteDataFile HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
}