StediDOCS
GuidesAPI Reference
This product is in Developer Preview

EDI Guides Storage

EDI Guides Store API

Authorization - API Key generated in Stedi terminal

Create a New Spec

POST/specs

Parameters

No parameters

Request body

application/json

Requiredstring
The value must be a string.
Optionalstring

If null or not passed on creation, this field will default to the description of the Transaction Set. The value must be a string.

Requiredstring
The value must be a string.

Possible values

X12-004010 X12-004020 X12-004030 X12-004040 X12-004050 X12-004060 X12-005010 X12-005020 X12-005030 X12-005040 ...

Requiredstring
Transaction Set Indentifier. The value must be a string.

Possible values

100 101 102 103 104 105 106 107 108 109 ...

Optionalstring
  • PUBLIC - Anyone can find, search, and view
  • UNLISTED - Anyone with the direct link can view
  • PRIVATE - Only visible to you. The value must be a string.

Possible values

PUBLIC UNLISTED PRIVATE

Optionalstring
Customizations which, when applied to the default definition, define this mapping guide. The value must be a string.
Optionalobject
Customizations which, when applied to the default definition, define this mapping guide
object object.

Optionalstring
Extra information pertinent to this mapping guide. The value must be a string.

Example

POST
https://guides.stedi.com/2021-06-05/specs

Get Spec by Id

GET/specs/{spec_id}

Parameters
Requiredpath
Id of the Spec The value must be a string.

Example

GET
https://guides.stedi.com/2021-06-05/specs/239a4b6b-08f8-4613-bc83-ab2f6a5db662

Publish New Spec Version

POST/specs/{spec_id}/versions

Parameters
Requiredpath
Id of the Spec The value must be a string.
Request body

application/json

Requiredstring
The value must be a string.

Example

POST
https://guides.stedi.com/2021-06-05/specs/71d7e076-2a4d-417e-bc5d-02b8b87c335b/versions

Get a Spec's Version by Id

GET/specs/{spec_id}/versions/{version_id}

Parameters
Requiredpath
Id of the Spec The value must be a string.
Requiredpath
Id of the Version The value must be a string.

Example

GET
https://guides.stedi.com/2021-06-05/specs/3049f6da-67e1-48bd-b246-8ceb54712df3/versions/618e4b22-ae09-4daa-9b5c-c2c497d45530

Get a Published Spec's Version by Id

GET/versions/{version_id}

Retrieve a particular version of a published implementation guide

Parameters
Requiredpath
Id of the Version The value must be a string.

Example

GET
https://guides.stedi.com/2021-06-05/versions/93217040-1217-44ba-b618-9db10450ca36