API docs by Redocly

myOpenFactory RESTful API (2.0.0)

Download OpenAPI specification:Download

Documentation for myOpenFactory Platform RESTful API.

The API uses preemptive basic authentication.

Transmissions

Communication with transmission service.

Fetch a list of available transmissions.

Notice: Every parameter which is not marked required is optional.

query Parameters
configID
required
string
Example: configID=dAGcZx

To address a specific process

size
integer [ 1 .. 100 ]
Default: 30
Example: size=10

Limit number of transmissions per page

page
integer >= 1
Default: 1
Example: page=2

Pagination

Responses

Response samples

Content type
application/json
[]

Create new transmission.

Notice: Every parameter which is not marked required is optional.

query Parameters
configID
required
string
Example: configID=dAGcZx

To address a specific process

header Parameters
x-myof-metadata-
string

headers starting with this prefix are user-defined metadata

Request Body schema: application/octet-stream
required

Transmission added to the platform

string <binary>

Responses

Response samples

Content type
application/json
{}

Confirm transfered transmission

Notice: Every parameter which is not marked required is optional.

path Parameters
id
required
string
Example: 807f1f77bcf86cd799439034
Request Body schema: application/json
required

Information about message.

error
boolean

Mark transmission and confirmed but with error

message
string

Log message

Responses

Request samples

Content type
application/json
{
  • "error": false,
  • "message": "Saved message to xyz"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "transmission confirmed",
  • "reference": "REQ-3128"
}

Attachments

Communication with attachment service.

Create a new attachment.

Notice: Every parameter which is not marked required is optional.

header Parameters
Content-Disposition
required
string

specifies presentational information for the object. For more information, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

Content-Type
required
string

application/octet-stream

x-myof-metadata-
string

headers starting with this prefix are user-defined metadata

Responses

Response samples

Content type
application/json
{
  • "id": "207f1f77bcf86cd799439045",
  • "url": "string",
  • "content-disposition": "attachment; filename=\"filename.jpg\"",
  • "content-type": "application/octet-stream",
  • "metadata": {
    },
  • "hash": {
    }
}

Messages

Communication with message service.

Fetch a list of attachments related to selected message.

Notice: Every parameter which is not marked required is optional.

path Parameters
id
required
string
Example: 807f1f77bcf86cd799439034

ID of message to query

Responses

Response samples

Content type
application/json
Example
[]