API docs by Redocly

myOpenFactory RESTful API (1.2.3)

Download OpenAPI specification:Download

Documentation for myOpenFactory Platform RESTful API.

The API uses preemptive basic authentication.

Transmissions

Communication with transmission service (incoming and outgoing).

Fetch a list of available transmissions.

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

query Parameters
configID
string
Example: configID=dAGcZx

To address a specific process

size
integer [ 1 .. 1024 ]
Default: 64
Example: size=128

Limit number of transmissions per page

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

Pagination

Responses

Response samples

Content type
application/json
{}

Add new transmission.

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

query Parameters
configID
string
Example: configID=dAGcZx

To address a specific process

test
boolean
Example: test=true

Indicate test transmission

Request Body schema: application/octet-stream

Transmission added to the platform

string <binary>

Responses

Response samples

Content type
application/json
{}

Fetch a specific transmission.

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

path Parameters
transmissionId
required
string
Example: 807f1f77bcf86cd799439034

Responses

Response samples

Content type
application/json
{}

Delete transfered transmission

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

path Parameters
transmissionId
required
string
Example: 807f1f77bcf86cd799439034

Responses

Response samples

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

Fetch a specific transmission data in binary (customer) format.

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

path Parameters
transmissionId
required
string
Example: 807f1f77bcf86cd799439034

Responses

Response samples

Content type
application/octet-stream
Example
UNB+UNOA:1+005435656:1+006415160:1+060515:1434+00000000000778'
UNH+00000000000117+INVOIC:D:97B:UN'
BGM+380+342459+9'
DTM+3:20060515:102'
RFF+ON:521052'
NAD+BY+792820524::16++CUMMINS MID-RANGE ENGINE PLANT'
NAD+SE+005435656::16++GENERAL WIDGET COMPANY'
CUX+1:USD'
LIN+1++157870:IN'
IMD+F++:::WIDGET'
QTY+47:1020:EA'
ALI+US'
MOA+203:1202.58'
PRI+INV:1.179'
LIN+2++157871:IN'
IMD+F++:::DIFFERENT WIDGET'
QTY+47:20:EA'
ALI+JP'
MOA+203:410'
PRI+INV:20.5'
UNS+S'
MOA+39:2137.58'
ALC+C+ABG'
MOA+8:525'
UNT+23+00000000000117'
UNZ+1+00000000000778'

Attachments

Communication with attachment service (incoming and outgoing).

Fetch specific attachment data.

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

path Parameters
attachmentId
required
string
Example: 807f1f77bcf86cd799439034

Responses

Response samples

Content type
application/octet-stream
Attachment content for e.g. pdf or jpg as binary

Fetch specific attachment.

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

path Parameters
attachmentId
required
string
Example: 807f1f77bcf86cd799439034

Responses

Response samples

Content type
application/json
{}

Fetch a list of attachments.

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

query Parameters
size
integer [ 1 .. 1024 ]
Default: 64
Example: size=128

Limit number of attachments per page

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

Pagination

Responses

Response samples

Content type
application/json
{}

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-meta-
string

headers starting with this prefix are user-defined metadata

Responses

Response samples

Content type
application/json
{}