Agent templates

OpenAPI Specification

• agent-templates
  • getGetting a list of agent templates
  • getGetting an agent template

API docs by Redocly

Public API (0.0.0)

2GIS GeoFlow Public API

agent-templates

Getting a list of agent templates

Returns a page with a list of agent templates.

Authorizations:

BearerAuth

query Parameters

limit required	integer Maximum number of templates in the response, from 1 to 100.
cursor	string Cursor for getting the next or previous page of results.

Responses

Response Schema: application/json

required	object (CursorResponse) Cursors for the next and previous result pages.
required	Array of objects (AgentTemplateResponse) Current page items.

Server URL

https://geoflow.2gis.ru/public/api/v1/agent-templates

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "cursor": {

  • "next": "string",
  • "prev": "string"

  },
• "items": [

  • {

    • "attributes": [

      • {

        • "extra": {

          • "dictionary_id": "60c05ead-13ab-475e-9dad-4a04d0b530a3",
          • "is_comment_field": true,
          • "is_comment_field_required": true,
          • "is_depot_duration_field": true,
          • "is_depot_duration_field_required": true,
          • "is_depot_ready_time_field": true,
          • "is_depot_ready_time_field_required": true,
          • "is_dimensions_field": true,
          • "is_dimensions_field_required": true,
          • "is_email_field": true,
          • "is_email_field_required": true,
          • "is_job_title_field": true,
          • "is_job_title_field_required": true,
          • "is_multi": true,
          • "is_name_field": true,
          • "is_name_field_required": true,
          • "is_phone_field": true,
          • "is_phone_field_required": true,
          • "is_time_limited_field": true,
          • "is_time_limited_field_required": true,
          • "is_units_field": true,
          • "is_units_field_required": true,
          • "is_volume_field": true,
          • "is_volume_field_required": true,
          • "is_weight_field": true,
          • "is_weight_field_required": true,
          • "skill_id": "3cd68bb3-8b7e-48be-8232-1b99b5b4b3aa"

          },
        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "is_identifier": true,
        • "is_required": true,
        • "json_schema": {

          • "property1": null,
          • "property2": null

          },
        • "meta": {

          • "alias": "string",
          • "is_deletable": true,
          • "is_sortable": true

          },
        • "name": "string",
        • "show_in_list": true,
        • "sort_order": 0,
        • "type": "text"

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "icon": {

      • "color": "string",
      • "name": "walk"

      },
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Getting an agent template

Returns an agent template by its identifier.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Agent template identifier.

Responses

Response Schema: application/json

required	Array of objects (TemplateAttribute) Agent template attributes.
created_at required	string <date-time> Date and time of template creation in RFC 3339 format.
required	object (AgentTemplateIconResponse) Agent icon on the map.
id required	string <uuid> Agent template identifier.
name required	string Agent template name.
updated_at required	string <date-time> Date and time of the template last update in RFC 3339 format.

Server URL

https://geoflow.2gis.ru/public/api/v1/agent-templates/{id}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "attributes": [

  • {

    • "extra": {

      • "dictionary_id": "60c05ead-13ab-475e-9dad-4a04d0b530a3",
      • "is_comment_field": true,
      • "is_comment_field_required": true,
      • "is_depot_duration_field": true,
      • "is_depot_duration_field_required": true,
      • "is_depot_ready_time_field": true,
      • "is_depot_ready_time_field_required": true,
      • "is_dimensions_field": true,
      • "is_dimensions_field_required": true,
      • "is_email_field": true,
      • "is_email_field_required": true,
      • "is_job_title_field": true,
      • "is_job_title_field_required": true,
      • "is_multi": true,
      • "is_name_field": true,
      • "is_name_field_required": true,
      • "is_phone_field": true,
      • "is_phone_field_required": true,
      • "is_time_limited_field": true,
      • "is_time_limited_field_required": true,
      • "is_units_field": true,
      • "is_units_field_required": true,
      • "is_volume_field": true,
      • "is_volume_field_required": true,
      • "is_weight_field": true,
      • "is_weight_field_required": true,
      • "skill_id": "3cd68bb3-8b7e-48be-8232-1b99b5b4b3aa"

      },
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "is_identifier": true,
    • "is_required": true,
    • "json_schema": {

      • "property1": null,
      • "property2": null

      },
    • "meta": {

      • "alias": "string",
      • "is_deletable": true,
      • "is_sortable": true

      },
    • "name": "string",
    • "show_in_list": true,
    • "sort_order": 0,
    • "type": "text"

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "icon": {

  • "color": "string",
  • "name": "walk"

  },
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "string",
• "updated_at": "2019-08-24T14:15:22Z"

}