StediDOCS
GuidesAPI Reference
This product is in Developer Preview

Parameters

Parameters lets you define, create, and store structured data that can be referenced programmatically so you can build scalable EDI integrations

Authorization - API Key generated in Stedi terminal

Lists parametersDev preview

GET/parameters

Retrieves a list of parameters

Parameters
Optionalquery
Maximum number of parameters to fetch. The value can range between 1 and 50, the default is 25.
Optionalquery
Last next_page_token seen in prior request from which to continue pagination The value must be a string.
Optionalquery
If set, only Parameters with IDs starting with provided prefix will be returned The value must be a string.
Optionalquery
If true, Parameter will have its value property populated undefined

Example

GET
https://parameters.stedi.com/2021-06-01/parameters?page_size=3&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&id_starts_with=...&with_values=true

List parameter setsDev preview

GET/parameter_sets

Retrieves a list of available parameter sets for current tenant

Parameters
Optionalquery
Maximum number of parameter sets to fetch The value can range between 1 and 50, the default is 25.
Optionalquery
Last next_page_token seen in prior request from which to continue pagination The value must be a string.
Optionalquery
If true, Parameter set will have their value property populated. Otherwise, the property will be omitted undefined
Optionalquery
Name of a parameter set, maximum of 50 values The values must be strings
Array of string objects.

Example

GET
https://parameters.stedi.com/2021-06-01/parameter_sets?page_size=44&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&with_values=true&name=...,...

Create a new parameter setDev preview

POST/parameter_sets

Creates a parameter set.

Parameters

No parameters

Request body

application/json

Requiredstring
Name of the parameter set. The value must be a string.
Optionalobject
Value of the parameter set which adheres to the schema
Optionalstring
ID of the Schema. The value must be a string.

Example

POST
https://parameters.stedi.com/2021-06-01/parameter_sets

Get a parameterDev preview

GET/parameters/{parameter_id}

Retrieves a parameter

Parameters
Requiredpath
id of the parameter The value must be a string.

Example

GET
https://parameters.stedi.com/2021-06-01/parameters/e9b05c9f-b5b7-46dc-a46f-2616cc979d76

Upsert a parameterDev preview

PUT/parameters/{parameter_id}

Upserts a parameter.

Parameters
Requiredpath
id of the parameter The value must be a string. The value must be a string. The value must be a string.
Request body

application/json

Required

Possible values

object string number

Required
Parameter value, can be string, number, or object.
Optionalstring
ID of the schema that dictates object parameter shape. The value must be a string.

Example

PUT
https://parameters.stedi.com/2021-06-01/parameters/966993d3-6b80-4c2f-b777-9b38cfe4a294

Delete a parameterDev preview

DELETE/parameters/{parameter_id}

Deletes a parameter

Parameters
Requiredpath
id of the parameter The value must be a string. The value must be a string.

Example

DELETE
https://parameters.stedi.com/2021-06-01/parameters/aa851373-843b-4135-9f73-6aa0153ac33b

Get a parameter setDev preview

GET/parameter_sets/{parameter_set_id}

Retrieves a parameter set

Parameters
Requiredpath
id of the parameter set The value must be a string.

Example

GET
https://parameters.stedi.com/2021-06-01/parameter_sets/7617403c-2d7d-423b-8278-b3da254e27e5

Update a parameter setDev preview

PUT/parameter_sets/{parameter_set_id}

Updates a parameter set

Parameters
Requiredpath
id of the parameter set The value must be a string. The value must be a string. The value must be a string.
Request body

application/json

Optionalobject
Value of the parameter set
Optionalstring
ID of the Schema. The value must be a string.

Example

PUT
https://parameters.stedi.com/2021-06-01/parameter_sets/3303b497-e9ea-4af7-b34a-854e1afa3d08

Delete a parameter setDev preview

DELETE/parameter_sets/{parameter_set_id}

Deletes a parameter set

Parameters
Requiredpath
id of the parameter set The value must be a string. The value must be a string.

Example

DELETE
https://parameters.stedi.com/2021-06-01/parameter_sets/1bee6f0b-5796-4350-adbf-d76781ada069

Increment a number parameterDev preview

PUT/parameters/{parameter_id}/operations/increment

Increments a number parameter.

Parameters
Requiredpath
id of the parameter The value must be a string.

Example

PUT
https://parameters.stedi.com/2021-06-01/parameters/3d0940f5-a142-49a8-96c1-d04f6c1d0b61/operations/increment