Skip to main content

Details

Get details about configuration section.

Details Config Api options​

note

This api doesn't have any options.

Calling Details Config Api​

For calling this api, the following details are required to apply:

URLMethod
http://localhost:5860/config/details/{name}GET

Since this api can be called through GET method, so it's required to fill the name with a proper config section name (which already defined or added into config).

Now, if we want to have these details in the form of an http api call, open a new terminal and enter the following command:

info

First of all make sure flowsynx is running.

curl -X GET http://localhost:5860/config/details/azfile

Also you can use Http Api test clients to test this api. Anyway, after executing this api, a result like below will be obtained.

{
  "data": {
    "id": "18c91659-858b-4fd6-bd20-0125cac86c27",
    "name": "azfile",
    "type": "FlowSynx.Storage/Azure.Files",
    "specifications": {
      "sharename": "<SHARENAME>",
      "accountKey": "<ACCOUNTKEY>",
      "accountNamE": "",
      "Connectionstring": "<CONNECTIONSTRING>"
    }
  },
  "messages": [],
  "succeeded": true
}

The answer is divided into three data, messages, and succeeded parts. succeeded indicates the status of the execution of this api which is boolean value and can be true or false. messages also indicates the list of possible messages that are returned with the response. data contains the data to be returned.

info

data part will have a value only when succeeded is true. If succeeded is false, this field will be null.

The information including in the result for this api is described as follows:

id: The guid-based identity for configuration item.
name: The name of configuration item (this name is unique).
type: The type of config item which represents the plugin type.
specifications: The specifications regarding returned configuration section. They should be returned in pairs of key value.