GuideIntegration appsAPIPOST /api/v1/synchronizer/datalist

This endpoint performs retrieving datalists from filter fields that marked with datalist flag.

Request

The inbound payload includes:

  • types - an array of selected type ids
  • account - selected account
  • field - name of requested field
  • dependsOn - object that contains filter key-value pairs of dependant fields
{
    "types": ["pullrequest", "branch"],
    "account": {
        "token": "token"
    },
    "field": "repository",
    "dependsOn": {
        "owner": "fibery"
    }
}

Response

The response from your API should include items that is a JSON-serialized list of name-value objects:

{
    "items": [
        {
            "title": "fibery/ui",
            "value": "124"
        },
        {
            "title": "fibery/core",
            "value": "125"
        }
    ]
}

The title in each object is what is displayed to the end-user for each value in a combobox and the value is what is stored with the filter and what will be passed with subsequent requests that utilize the user-created filter.