Product files

OpenAPI V2

Add documentation.

post

Add documentation to the platform for users to access. Admin functionality only.

Authorizations

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

authorstring | nullableoptional

The author of the record

Example: [e-mail]

releaseIdstring | nullableoptional

The ID of the release which relates to.

Example: 89

typestring | nullableoptional

Type of files to be uploaded.

Example: application (.exe)

kindstring | nullableoptional

The kind of the files.

Example: Manual

createdOnstring · date-timeoptional

The exact date when the file is stored.

Example: 2020-01-01/2020-12-31

isPublicbooleanoptional

domainsstring[] | nullableoptional

The allowed domains to able to access the documentation.

fileobjectoptional

namestring | nullableoptional

Name of the file.

Example: My test manual

descriptionstring | nullableoptional

Additional description for the files.

Example: Useful guide for new SemansysNext features

Responses

application/json

post

HTTPcURLJavaScriptPython

POST /customer-corner/product-files HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "author": "[e-mail]",
  "releaseId": "89",
  "type": "application (.exe)",
  "kind": "Manual",
  "createdOn": "2020-01-01/2020-12-31",
  "isPublic": true,
  "domains": [
    "text"
  ],
  "file": {
    "data": "PD94bWwgdmVyc2lvbj0...",
    "fileNameNoPath": "My file.xbrl",
    "offset": 1,
    "firstChunk": true,
    "size": 1
  },
  "name": "My test manual",
  "description": "Useful guide for new SemansysNext features"
}

No Content

Deletes documentation by ID.

delete

Delete documentation for ID from the platform. Admin functionality only.

Authorizations

Path parameters

idstringrequired

ID of the product file.

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Responses

text/plainapplication/jsontext/json

delete

HTTPcURLJavaScriptPython

DELETE /customer-corner/product-files/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*

No Content