StatusSupportCommunity

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: [email protected]
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.

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
201

Created

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

{
  "author": "[email protected]",
  "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
202

Accepted

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

No content
PreviousChunkNextDownload

Was this helpful?