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

200

Content type

application/json

{"transmissions": [{"id": "507f1f77bcf86cd799439011",
"url": "https://edi.myopenfactory.net/rest/v1/transmissions/{transmissionId}",
"data_url": "https://edi.myopenfactory.net/rest/v1/transmissions/{transmissionId}/data",
"hash": {"method": "SHA256",
"sum": "c01b39c7a35ccc3b081a3e83d2c71fa9a767ebfeb45c69f08e17dfe3ef375a7b"
},
"test": true,
"metadata": {"messageID": "189023",
"date": "2013-01-02"
},
"attachments": [{"url": "https://myopenfactory.net/cockpit/attachment/...",
"item_id": 10
}
]
}
]
}

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
required

Transmission added to the platform

string <binary>

Responses

Response samples

200
413

Content type

application/json

{"id": "507f1f77bcf86cd799439011",
"url": "https://edi.myopenfactory.net/rest/v1/transmissions/{transmissionId}",
"data_url": "https://edi.myopenfactory.net/rest/v1/transmissions/{transmissionId}/data",
"hash": {"method": "SHA256",
"sum": "c01b39c7a35ccc3b081a3e83d2c71fa9a767ebfeb45c69f08e17dfe3ef375a7b"
},
"test": true
}

Fetch a specific transmission.

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

path Parameters

transmissionId

required

string

Example: 807f1f77bcf86cd799439034

Responses

Response samples

200
404

Content type

application/json

{"id": "507f1f77bcf86cd799439011",
"url": "https://edi.myopenfactory.net/rest/v1/transmissions/{transmissionId}",
"data_url": "https://edi.myopenfactory.net/rest/v1/transmissions/{transmissionId}/data",
"hash": {"method": "SHA256",
"sum": "c01b39c7a35ccc3b081a3e83d2c71fa9a767ebfeb45c69f08e17dfe3ef375a7b"
},
"test": true,
"metadata": {"messageID": "189023",
"date": "2013-01-02"
},
"attachments": [{"url": "https://myopenfactory.net/cockpit/attachment/...",
"item_id": 10
}
]
}

Delete transfered transmission

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

path Parameters

transmissionId

required

string

Example: 807f1f77bcf86cd799439034

Responses

Response samples

200
404

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

200
404

Content type

application/octet-stream

Example

edifact

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

200
404

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

200
404

Content type

application/json

{"id": "207f1f77bcf86cd799439045",
"url": "https://edi.myopenfactory.net/rest/v1/attachment/{attachmentId}",
"data_url": "https://edi.myopenfactory.net/rest/v1/attachment/{attachmentId}/data",
"content-disposition": "attachment; filename=\"filename.jpg\"",
"content-type": "application/octet-stream",
"metadata": {"messageID": "189023",
"date": "2013-01-02"
},
"hash": {"method": "SHA256",
"sum": "c01b39c7a35ccc3b081a3e83d2c71fa9a767ebfeb45c69f08e17dfe3ef375a7b"
}
}

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

200

Content type

application/json

{"attachments": [{"id": "207f1f77bcf86cd799439045",
"url": "https://edi.myopenfactory.net/rest/v1/attachment/{attachmentId}",
"data_url": "https://edi.myopenfactory.net/rest/v1/attachment/{attachmentId}/data",
"content-disposition": "attachment; filename=\"filename.jpg\"",
"content-type": "application/octet-stream",
"metadata": {"messageID": "189023",
"date": "2013-01-02"
},
"hash": {"method": "SHA256",
"sum": "c01b39c7a35ccc3b081a3e83d2c71fa9a767ebfeb45c69f08e17dfe3ef375a7b"
}
}
]
}

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

200

Content type

application/json

{"id": "207f1f77bcf86cd799439045",
"url": "https://edi.myopenfactory.net/rest/v1/attachment/{attachmentId}",
"data_url": "https://edi.myopenfactory.net/rest/v1/attachment/{attachmentId}/data",
"content-disposition": "attachment; filename=\"filename.jpg\"",
"content-type": "application/octet-stream",
"metadata": {"messageID": "189023",
"date": "2013-01-02"
},
"hash": {"method": "SHA256",
"sum": "c01b39c7a35ccc3b081a3e83d2c71fa9a767ebfeb45c69f08e17dfe3ef375a7b"
}
}

myOpenFactory RESTful API (1.2.3)

Transmissions

Fetch a list of available transmissions.

query Parameters

Responses

Response samples

Add new transmission.

query Parameters

Request Body schema: application/octet-streamrequired

Responses

Response samples

Fetch a specific transmission.

path Parameters

Responses

Response samples

Delete transfered transmission

path Parameters

Responses

Response samples

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

path Parameters

Responses

Response samples

Attachments

Fetch specific attachment data.

path Parameters

Responses

Response samples

Fetch specific attachment.

path Parameters

Responses

Response samples

Fetch a list of attachments.

query Parameters

Responses

Response samples

Create a new attachment.

header Parameters

Responses

Response samples

Request Body schema: application/octet-stream
required