Generic topics

Overview terms

Name	Type	Required	Description
Name	string	Yes	Name of the generic topic
Description	string	No	Description of the generic topic
Code	string	No	Code of the generic topic
externalId	string	No	Probably needed when using the API with externalIds
blocks	Array object	No	You can pass a block object to the generic topic. This block will be used when creating an evaluation from a calendar.
block->topicType	String	Yes (in a block object)	The block type (you can manage generic topic blocks on top organisation)
block->questionSets	Array object	No	Array of questionSet ids. You can use id or code of the questionSet [{id: number, code: string}]
block->index	integer	No	Order of the blocks
labels	Array object	No	Add labels to the generic topic
labels->name	string	Yes (in a label object)	name of the label

Get a list of generic topics

GET https://api-portal.evalytics.nl/genericTopic

Query Parameters

Name	Type	Description
q	String	Search for a specific generic topic
archived	boolean	Filter generic topics on archived (default=null)
populateBlocks	boolean	Populate blocks object (default = false)
populateLabels	boolean	Populate labels (default = false)
skip	number	Total items to be skipped for pagination (default=0)
limit	number	Limit the total items returned from the api (default=30)
status	string array	Filter list on active, archived, deleted (default = active)

200: OK

{
	"metadata": {
		"timestamp": "2023-01-11T10:00:37.605Z",
		"resultSet": {
			"count": 1,
			"limit": 30,
			"skip": 0
		}
	},
	"results": [
		{
			"id": 1,
			"name": "Example topic",
			"description": "",
			"externalId": "",
			"code": "",
			"organisation": 4,
			"topOrganisation": 3,
			"updatedAt": null,
			"modifiedBy": null,
			"createdAt": "2023-01-03T16:08:45.000Z",
			"createdBy": 1,
			"deleted": false,
			"archived": false,
			"labels": [{
				"name": "Example label"
			}]
		}
	]
}

Get a generic topic

GET https://api-portal.evalytics.nl/genericTopic/:id

Path Parameters

Name	Type	Description
id*	number	Id or externalId of the genericTopic

200: OK

{
			"id": 1,
			"name": "Example topic",
			"description": "",
			"externalId": "",
			"code": "",
			"organisation": 4,
			"topOrganisation": 3,
			"updatedAt": null,
			"modifiedBy": null,
			"createdAt": "2023-01-03T16:08:45.000Z",
			"createdBy": 1,
			"deleted": false,
			"archived": false,
			"labels": [{
				"name": "Example label"
			}]
}

Creates a generic topic

POST https://api-portal.evalytics.nl/genericTopic

200: OK

{
			"id": 1,
			"name": "Example topic",
			"description": "",
			"externalId": "",
			"code": "",
			"organisation": 4,
			"topOrganisation": 3,
			"updatedAt": null,
			"modifiedBy": null,
			"createdAt": "2023-01-03T16:08:45.000Z",
			"createdBy": 1,
			"deleted": false,
			"archived": false,
			"labels": [{
				"name": "Example label"
			}]
}

{
    "name": (string - required),
    "description": (string),
    "code": (string),
    "externalId": (string),
    "blocks": [{
        "name": (string - required),
        "topicType": {
            "id": (integer - required or use type),
            "type": (string - required or use id)
        } - (required),
        "index": (integer),
        "questionSets": [{
            "id": (integer - required or use code),
            "code": (string - required or use id)
        }] - (optional)
    }]- (optional),
    "labels": [{
        "name": (string - required)
    }] - (optional)
}

Update a generic topic

PUT https://api-portal.evalytics.nl/genericTopic/:id

200: OK

{
			"id": 1,
			"name": "Example topic updated",
			"description": "",
			"externalId": "",
			"code": "",
			"organisation": 4,
			"topOrganisation": 3,
			"updatedAt": null,
			"modifiedBy": null,
			"createdAt": "2023-01-03T16:08:45.000Z",
			"createdBy": 1,
			"deleted": false,
			"archived": false,
			"labels": [{
				"name": "Example label"
			}]
		}

{
    "name": (string - required),
    "description": (string),
    "code": (string),
    "externalId": (string),
    "blocks": [{
        "topicType": {
            "id": (integer - required or use type),
            "type": (string - required or use id)
        }
        "index": (integer),
        "questionSets": [{
            "id": (integer - required or use code),
            "code": (string - required or use id)
        }] - (optional)
    }]- (optional),
    "labels": [{
        "name": (string - required)
    }] - (optional)
}

Archive a generic topic

POST https://api-portal.evalytics.nl/genericTopic/:id/archive

Path Parameters

Name	Type	Description
*	number	id or externalId of the genericTopic

Query Parameters

Name	Type	Description
undo	boolean	Undo the archiving action

200: OK

{
    // Response
}

Delete a generic topic

DELETE https://api-portal.evalytics.nl/genericTopic/:id

Path Parameters

Name	Type	Description
id*	number	id or externalId of the genericTopic

Query Parameters

Name	Type	Description
undo	boolean	Undo the archiving action

200: OK

{
    // Response
}