Reductech.Sequence.Connectors.Rest
0.17.0
dotnet add package Reductech.Sequence.Connectors.Rest --version 0.17.0
NuGet\Install-Package Reductech.Sequence.Connectors.Rest -Version 0.17.0
<PackageReference Include="Reductech.Sequence.Connectors.Rest" Version="0.17.0" />
paket add Reductech.Sequence.Connectors.Rest --version 0.17.0
#r "nuget: Reductech.Sequence.Connectors.Rest, 0.17.0"
// Install Reductech.Sequence.Connectors.Rest as a Cake Addin #addin nuget:?package=Reductech.Sequence.Connectors.Rest&version=0.17.0 // Install Reductech.Sequence.Connectors.Rest as a Cake Tool #tool nuget:?package=Reductech.Sequence.Connectors.Rest&version=0.17.0
Sequence® Rest Connector
Sequence® is a collection of libraries for automation of cross-application e-discovery and forensic workflows.
The REST Connector enables users to interact with REST services in sequences.
This connector works by generating steps from an OpenAPI specification defined in the configuration.
"reductech-scl.sequence.connectors": {
"Reductech.Sequence.Connectors.Rest": {
"Id": "Reductech.Sequence.Connectors.Rest",
"Version": "0.13.0",
"Settings": {
"Specifications": [{
"Name": "Examples",
"BaseURL": "http://baseURL",
"SpecificationURL": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/api-with-examples.json"
}]
}
}
}
Each Specification has the following properties
Name | Required | Type | Description |
---|---|---|---|
Name | ✔ | string |
The name of the Specification |
BaseURL | ✔ | string |
The base url to send queries to |
Specification | string |
Text of the OpenAPI specification to use | |
SpecificationURL | string |
Url of the Specification to use | |
SpecificationFilePath | string |
File path of the Specification to use. |
Exactly one of Specification, SpecificationURL, and SpecificationFilePath must be set.
Each operation in the specification will map onto its own step. The name of the step will be the Specification name concatenated with the OperationId separated by an underscore. Each operation parameter will map to a Step parameter. Each security definition will map to a Step parameter.
SCL examples available here.
Documentation
Download
Try SCL and Core
https://sequence.sh/playground
Package Releases
Can be downloaded from the Releases page.
NuGet Packages
Release nuget packages are available from nuget.org.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Microsoft.OpenApi (>= 1.3.2)
- Microsoft.OpenApi.Readers (>= 1.3.2)
- Reductech.Sequence.Core (>= 0.17.0)
- System.IO.Abstractions (>= 17.1.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.