@microfocus/alm-octane-js-rest-sdk/dist/routes/meta.json

NodeJS wrapper for the Open Text ALM Octane API

{
	"defines": {
		"constants": {
			"name": "Octane",
			"description": "A Node.JS module which provide an object oriented wrapper for the HPE ALM Octane API",
			"protocol": "https",
			"host": "",
			"port": "443"
		},
		"params": {
			"text_search": {
				"type": "string",
				"required": false,
				"description": "elastic search"
			},
			"limit": {
				"type": "integer",
				"required": false,
				"description": "The number of instances to return in each page from the results of the query."
			},
			"offset": {
				"type": "integer",
				"required": false,
				"description": "The first position to return from the results of the query. The default is 0."
			},
			"fields": {
				"type": "string",
				"required": false,
				"description": "The fields to be returned in the results of the query."
			},
			"order_by": {
				"type": "string",
				"required": false,
				"description": "Sorts the entities returned in the results of the query."
			},
			"query": {
				"type": "query",
				"required": false,
				"description": "Filter entities returned in the results of the query."
			},
			"id": {
				"type": "integer",
				"required": true,
				"description": "The id."
			},
			"filename": {
				"type": "string",
				"required": true,
				"description": "Used for attachments when needing to specify the attachment name"
			}
		}
	},
	"metadata": {
		"get-entities": {
			"url": "/metadata/entities",
			"method": "GET",
			"params": {
				"$query": null
			},
			"description": "Gets entities list"
		},
		"get-fields": {
			"url": "/metadata/fields",
			"method": "GET",
			"params": {
				"$query": null
			},
			"description": "Get fields list"
		}
	},
	"severities": {
		"get-all": {
			"url": "/list_nodes?query=\"list_root EQ {id EQ ^list_node.severity^}\"&order_by=id",
			"method": "GET",
			"params": {},
			"description": "Gets severities list"
		}
	},
	"priorities": {
		"get-all": {
			"url": "/list_nodes?query=\"list_root EQ {id EQ ^list_node.priority^}\"&order_by=id",
			"method": "GET",
			"params": {},
			"description": "Gets priorities list"
		}
	},
	"attachments": {
		"create": {
			"url": "/attachments",
			"method": "POST",
			"content-type": "multipart/form-data",
			"params": {
				"owner_release": {
					"type": "reference",
					"required": false,
					"description": "Owner release",
					"field_type_data": {
						"multiple": false,
						"targets": [
							{
								"type": "release"
							}
						]
					}
				},
				"owner_work_item": {
					"type": "reference",
					"required": false,
					"description": "Owner work item",
					"field_type_data": {
						"multiple": false,
						"targets": [
							{
								"type": "story"
							},
							{
								"type": "quality_story"
							},
							{
								"type": "theme"
							},
							{
								"type": "work_item_root"
							},
							{
								"type": "feature"
							},
							{
								"type": "defect"
							}
						]
					}
				},
				"name": {
					"type": "string",
					"required": true,
					"description": "Name",
					"max_length": 255
				},
				"owner_test": {
					"type": "reference",
					"required": false,
					"description": "Owner test",
					"field_type_data": {
						"multiple": false,
						"targets": [
							{
								"type": "gherkin_test"
							},
							{
								"type": "test_manual"
							},
							{
								"type": "test_suite"
							}
						]
					}
				},
				"description": {
					"type": "string",
					"required": false,
					"description": "Description",
					"max_length": 2000
				},
				"owner_milestone": {
					"type": "reference",
					"required": false,
					"description": "Owner milestone",
					"field_type_data": {
						"multiple": false,
						"targets": [
							{
								"type": "milestone"
							}
						]
					}
				},
				"file": {
					"type": "file",
					"required": true,
					"description": "The absolute file path"

				}
			},
			"description": "Create a single attachment."
		},
		"download": {
			"url": "/attachments/:id/:filename",
			"method": "GET",
			"accept": "application/octet-stream",
			"params": {
				"$id": null,
				"$filename": null
			},
			"description": "Downloads a single attachment."
		}
	}
}