StediDOCS
This product is in Developer Preview

EDI Guides Storage

EDI Guides Store API
Authorization - API Key generated in Stedi terminal

Download OpenAPI

List Guides

GET/guides
Returns a list for all guides for the current account.
Parameters
Optionalquery
Number of items to return per page
Optionalquery
Last token from which to continue pagination

Example

GET
https://guides.stedi.com/2021-06-05/guides?page_size=11&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...

Create a New Guide

POST/guides
Request body

application/json

Requiredstring
Optionalstring

If null or not passed on creation, this field will default to the description of the Transaction Set.

Requiredstring

Possible values

X12-003010 X12-003020 X12-003030 X12-003040 X12-003050 X12-003060 X12-003070 X12-004010 X12-004020 X12-004030 ...

Requiredstring
Transaction Set Indentifier

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

Possible values

PUBLIC UNLISTED PRIVATE

Optionalobject
Customizations which, when applied to the default definition, define this mapping guide
object object.

Optionalobject
Customizations which, when applied to the default definition, define this mapping guide
object object.

Optionalstring
Extra information pertinent to this mapping guide.

Example

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

Get Guide by Id

GET/guides/{guide_id}
Parameters
Requiredpath
Id of the Guide

Example

GET
https://guides.stedi.com/2021-06-05/guides/0c18d27b-151c-4e0f-8ae0-044bdc732fad

Delete Guide

DELETE/guides/{guide_id}

Deletes a Guide and ALL related versions.

Parameters
Requiredpath
Id of the Guide

Example

DELETE
https://guides.stedi.com/2021-06-05/guides/24657aba-7372-485c-a2fb-2dd8c0a23cf8

Update a Guide

PATCH/guides/{guide_id}
Parameters
Requiredpath
Id of the Guide
Request body

application/json

Optionalstring
Optionalstring

If null is passed, this field will default to the description of the Transaction Set.

Optionalstring
  • PUBLIC - Anyone can find, search, and view
  • UNLISTED - Anyone with the direct link can view
  • PRIVATE - Only visible to you

Possible values

PUBLIC UNLISTED PRIVATE

Optionaldate-time

Optionally pass this parameter to guarantee that you only update the guide if there haven't been any changes since your last retrieved the guide record.

If this parameter is not passed, race conditions can occur and you may overwrite other's changes.

Optionalobject
Customizations which, when applied to the default definition, define this mapping guide
object object.

Optionalobject
Customizations which, when applied to the default definition, define this mapping guide
object object.

Optionalstring
Extra information pertinent to this mapping guide.

Example

PATCH
https://guides.stedi.com/2021-06-05/guides/b9534761-e911-459e-934b-856a47eca6d3

List a Guide's Versions

GET/guides/{guide_id}/versions
Returns a list for all versions for a Guide.
Parameters
Requiredpath
Id of the Guide
Optionalquery
Number of items to return per page
Optionalquery
Last token from which to continue pagination

Example

GET
https://guides.stedi.com/2021-06-05/guides/b96e1159-6ceb-4a6e-8a48-e665e7c5316f/versions?page_size=23&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...

Publish New Guide Version

POST/guides/{guide_id}/versions
Parameters
Requiredpath
Id of the Guide
Request body

application/json

Requiredstring

Example

POST
https://guides.stedi.com/2021-06-05/guides/2c706f0b-8ed8-4602-a7a5-4a5542a9f04f/versions

Get a Guide's Version by Id

GET/guides/{guide_id}/versions/{version_id}
Parameters
Requiredpath
Id of the Guide
Requiredpath

Id of the Version, or latest to retrieve the most recent Version

Example

GET
https://guides.stedi.com/2021-06-05/guides/13703d9b-5691-42df-817b-87801e009964/versions/13ecaf32-f64f-475e-af0c-b0d0e4d58687

Delete a Guide's Version by Id

DELETE/guides/{guide_id}/versions/{version_id}
Parameters
Requiredpath
Id of the Guide
Requiredpath

Id of the Version, or latest to retrieve the most recent Version

Example

DELETE
https://guides.stedi.com/2021-06-05/guides/21882e2d-957c-4f8f-a5cc-023a3e54319a/versions/ecb7c20e-6cd3-47b6-8445-46b59adb409a

Update a Version

PATCH/guides/{guide_id}/versions/{version_id}
Parameters
Requiredpath
Id of the Guide
Requiredpath

Id of the Version, or latest to retrieve the most recent Version

Request body

application/json

Requiredstring

Example

PATCH
https://guides.stedi.com/2021-06-05/guides/9a434851-3420-4e83-a22e-9dbe366f4b64/versions/a275d33d-3eb0-4084-8b4e-7a9d8519cc7b

Get a Guide's Version by Id

GET/versions/{version_id}
Retrieve a particular version of a implementation guide
Parameters
Requiredpath
Id of the Version

Example

GET
https://guides.stedi.com/2021-06-05/versions/542ba8ad-5bdf-402d-9e83-a640520e1726