Operation
get /data/otn/connectionTemplates/folders
getFolders (getFolders : /data/otn/connectionTemplates/folders)
getFolders
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/otn/connectionTemplates/folders/{folderId}
getFolders (getFolders : /data/otn/connectionTemplates/folders/{folderId})
getFolders
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderId | required | folderId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
nodeType | optional | --- |
folderType | optional | --- |
publish | optional | --- |
page | optional | --- |
tmpltype | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ObjectNode]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/otn/connectionTemplates/{templateName}
getTemplateDataForNBI (getTemplateDataForNBI : /data/otn/connectionTemplates/{templateName})
getTemplateDataForNBI
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
templateName | required | templateName | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
folder | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NBITemplateDataResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/otn/connectionTemplates/templates/{templateId}
getTemplateInfoAndData (getTemplateInfoAndData : /data/otn/connectionTemplates/templates/{templateId})
getTemplateInfoAndData
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
templateId | required | templateId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | --- |
tmpltype | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
TemplateObject
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/otn/connectionTemplates/templates/{folderName}/{templateName}
getTemplateInfoByName (getTemplateInfoByName : /data/otn/connectionTemplates/templates/{folderName}/{templateName})
getTemplateInfoByName
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderName | required | folderName | --- |
templateName | required | templateName | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | --- |
tmpltype | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/otn/connectionTemplates/folders/{folderId}/templates
getTemplates (getTemplates : /data/otn/connectionTemplates/folders/{folderId}/templates)
getTemplates
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderId | required | folderId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | --- |
tmpltype | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
get /data/otn/connectionTemplates/folders/{folderId}/templates/{templateId}
getTemplates (getTemplates : /data/otn/connectionTemplates/folders/{folderId}/templates/{templateId})
getTemplates
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderId | required | folderId | --- |
templateId | required | templateId | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | --- |
searchKey | optional | --- |
context | optional | --- |
tmpltype | optional | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ObjectNode]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
*/*
External Docs
See Also :
Operation
post /data/otn/connectionTemplates/NBI_MAPPING
nbiMapping (nbiMapping : /data/otn/connectionTemplates/NBI_MAPPING)
nbiMapping
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | body | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NBITemplateDataResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
text/xml
application/json
External Docs
See Also :
HashMap«string,ArrayList«NBITemplateParameter»»
Name |
Type |
Description |
Enum |
---|
NBITemplateDataResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
reqCompletionStatus | Integer integer |
--- | --- |
requestId | Long long |
--- | --- |
clientName | String string |
--- | --- |
clientLocation | String string |
--- | --- |
clientUser | String string |
--- | --- |
sessionId | String string |
--- | --- |
mdcId | String string |
--- | --- |
sequenceNum | Integer integer |
--- | --- |
moreToCome | Boolean boolean |
--- | --- |
messages | array[OtnI18nMessage] OtnI18nMessage |
--- | --- |
errcde | String string |
--- | --- |
errorParams | array[Object] object |
--- | --- |
folderFullName | String string |
--- | --- |
templateName | String string |
--- | --- |
data | HashMap«string,ArrayList«NBITemplateParameter»» HashMap«string,ArrayList«NBITemplateParameter»» |
--- | --- |
failReason | String string |
--- | --- |
failMessage | String string |
--- | --- |
failedCompletion | Boolean boolean |
--- | --- |
successfulCompletion | Boolean boolean |
--- | --- |
timeout | Long long |
--- | --- |
nadString | String string |
--- | --- |
ObjectNode
Name |
Type |
Description |
Enum |
---|---|---|---|
nodeType | String string |
--- | [ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING] |
binary | Boolean boolean |
--- | --- |
double | Boolean boolean |
--- | --- |
number | Boolean boolean |
--- | --- |
int | Boolean boolean |
--- | --- |
missingNode | Boolean boolean |
--- | --- |
long | Boolean boolean |
--- | --- |
containerNode | Boolean boolean |
--- | --- |
object | Boolean boolean |
--- | --- |
pojo | Boolean boolean |
--- | --- |
integralNumber | Boolean boolean |
--- | --- |
floatingPointNumber | Boolean boolean |
--- | --- |
short | Boolean boolean |
--- | --- |
bigDecimal | Boolean boolean |
--- | --- |
bigInteger | Boolean boolean |
--- | --- |
textual | Boolean boolean |
--- | --- |
boolean | Boolean boolean |
--- | --- |
valueNode | Boolean boolean |
--- | --- |
float | Boolean boolean |
--- | --- |
array | Boolean boolean |
--- | --- |
null | Boolean boolean |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
---|---|---|---|
messageType | String string |
--- | [Info, Warning, Error] |
messageUnformatted | String string |
--- | --- |
validPropertyResourceMessage | Boolean boolean |
--- | --- |
messageId | String string |
--- | --- |
messageParams | array[String] string |
--- | --- |
messageTime | Long long |
--- | --- |
message | String string |
--- | --- |