Returns a description of a given service action.
643 matches
Other/OSDB REST API v1
Describe action
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
{
"type": "object",
"properties": {
"actionId": {
"type": "string"
},
"serviceId": {
"type": "string"
}
},
"required": [
"actionId",
"serviceId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
{
"type": "object",
"required": [
"api",
"method",
"response",
"status"
],
"properties": {
"api": {
"type": "string",
"description": "The path of the REST API method"
},
"method": {
"type": "string",
"description": "The name of the REST API method"
},
"response": {
"type": "object",
"required": [
"action_id",
"entry_point"
],
"properties": {
"action_id": {
"type": "string",
"description": "A unique one word identifier for the action."
},
"description": {
"type": "string",
"description": "A short description of the action."
},
"entry_point": {
"type": "object",
"required": [
"content_types",
"description",
"encoding_types",
"http_method",
"name",
"parameters",
"url",
"url_template"
],
"properties": {
"content_types": {
"type": "array",
"description": "The supported MIME type(s) for an EntryPoint response.",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "A short description of the action. Optional - may be null."
},
"encoding_types": {
"type": "array",
"description": "The supported MIME type(s) for an EntryPoint request. Null if not applicable.",
"items": {
"type": "string"
}
},
"http_method": {
"type": "string",
"description": "The HTTP method used by the EntryPoint.",
"enum": [
"GET",
"PUT",
"POST",
"DELETE"
]
},
"name": {
"type": "string",
"description": "A word or short phrase to be used as the action's display name. Optional - may be null."
},
"parameters": {
"type": "array",
"description": "Descriptions of the EntryPoint parameters. Null if not applicable.",
"items": {
"type": "object",
"required": [
"parameter_name",
"display_name",
"description",
"type",
"required",
"permitted_values"
],
"properties": {
"description": {
"type": "string",
"description": "A short description of the parameter for use in the OSDB Action Console. Optional - may be null."
},
"display_name": {
"type": "string",
"description": "The parameter's display name in the OSDB Action Console. Optional - may be null."
},
"parameter_name": {
"type": "string",
"description": "The parameter name as present in the HTTP request. e.g. the key name in a query string key-value pair."
},
"permitted_values": {
"type": "array",
"description": "If the parameter accepts only a limited set of values, the allowed set of values. Null if not applicable.",
"items": {
"type": "string"
}
},
"required": {
"type": "integer",
"format": "int32",
"description": "A flag indicating if the parameter is optional."
},
"type": {
"type": "string",
"description": "The type of the parameter, indicating its location in the HTTP request.",
"enum": [
"query",
"header",
"uri",
"path",
"body"
]
}
}
}
},
"url": {
"type": "string",
"format": "uri",
"description": "The EntryPoint URL. It will be non-null if url_template is null."
},
"url_template": {
"type": "string",
"format": "uri-template",
"description": "The EntryPoint's URL template. Only required if the entry point URL is parameterized. Property 'url' will be null if url_template is non-null."
}
}
}
}
},
"status": {
"type": "string",
"enum": [
"success"
]
}
}
}