API Endpoint: Get Parsers
Method: GET
Endpoint: https://{{base_url}}/zsa/api/v2/parsers
This endpoint retrieves a list of parsers available in the system. Upon successful execution, it returns a JSON array containing details about each parser.
Request Parameters
This endpoint does not require any request parameters.
Response Format
The response will be a JSON array with the following structure:
-
id: The unique identifier for the parser (string).
-
createdAt: The timestamp indicating when the parser was created (string).
-
label: A human-readable label for the parser (string).
-
state: The current state of the parser (string).
-
deactivationAllowed: A boolean indicating whether the parser can be deactivated (boolean).
-
type: The type of the parser (string).
-
information: An array of objects containing additional information about the parser, with each object having:
-
name: The name of the information (string).
-
value: The value of the information (string).
-
type: The type of the information (string).
-
label: A label for the information (string).
-
description: A description of the information (string).
-
unit: The unit of measurement for the information (string).
-
-
properties: An array of objects detailing the properties of the parser, with each object containing:
-
name: The name of the property (string).
-
value: The current value of the property (string).
-
defaultValue: The default value of the property (string).
-
type: The type of the property (string).
-
complexity: The complexity level of the property (string).
-
label: A label for the property (string).
-
description: A description of the property (string).
-
unit: The unit of measurement for the property (nullable string).
-
Example Response
[
{
"id": "",
"createdAt": "",
"label": "",
"state": "",
"type": "",
"information": [
{
"name": "",
"value": "",
"type": "",
"label": "",
"description": "",
"unit": ""
}
],
"properties": [
{
"name": "",
"value": "",
"defaultValue": "",
"type": "",
"complexity": "",
"label": "",
"description": "",
"unit": null
}
],
"deactivationAllowed": true
}
]