REST APIs
The solutions framework provides standard APIs via REST. The base URI for these REST APIs is:
<HTTP protocol>://<web server>/<web bridge>/<Longview identifier>/api/app/solutions
The following services are provided:
Path | Methods | Authorizations Required |
|---|---|---|
app/solutions | GET / HEAD | Connect to Application Framework |
app/solutions/attributevalue | GET / HEAD | Connect to Application Framework |
app/solutions/attributevalue/symbol | GET / HEAD | Connect to Application Framework |
app/solutions/attributevalue/system | GET / HEAD | Connect to Application Framework |
app/solutions/attributevalue/user | GET / HEAD | Connect to Application Framework |
app/solutions/data | GET / HEAD / PUT | Connect to Application Framework View Data (GET) Modify Data (PUT) |
app/solutions/data/<name> | GET / HEAD / PUT | Connect to Application Framework View Data (GET) Modify Data (PUT) |
app/solutions/hierarchies | GET / HEAD / PUT | Connect to Application Framework Symbols Create (PUT) Symbols Modify (PUT) Symbols Delete (PUT) |
To execute any solutions framework REST API, you must first create a session. See Creating a New Session.
Remember to delete any session created after you are finished with it. See Destroying a Session.
Responses
The following response headers will be returned with every request:
Header | Use |
|---|---|
Status | Representation of the result of the request in the form: <status code> <status> |
Content-Type | The type of content returned by the request |
Content-Length | The length of the content returned in the response body by the request |
The following standard response statuses may be returned in the response header for a request:
Status | Methods | Additional Response Headers |
|---|---|---|
200 OK | GET / HEAD / PUT / DELETE | LVStatus |
201 Created | POST | Location |
400 Bad Request | All |
|
404 Not Found | All |
|
405 Method Not Allowed | PUT / POST / DELETE | Allow |
406 Not Acceptable | GET / HEAD |
|
415 Unsupported Media Type | PUT / POST |
|
GET solutions
A GET request targeting solutions will return a list of links to the services provided in JSON format.
Example
{
"links": {
"attributevalue": "http://<web bridge>/<Longview identifier>/api/app/solutions/attributevalue",
"data": "http://<web bridge>/<Longview identifier>/api/app/solutions/data",
"hierarchies": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies"
}
}
GET solutions/attributevalue
A GET request targeting solutions/attributevalue will return a list of links to the services provided in JSON format.
Example
{
"links": {
"symbol": "http://<web bridge>/<Longview identifier>/api/app/solutions/attributevalue/symbol",
"system": "http://<web bridge>/<Longview identifier>/api/app/solutions/attributevalue/system",
"user": "http://<web bridge>/<Longview identifier>/api/app/solutions/attributevalue/user"
}
}
GET solutions/attributevalue/symbol
A GET request targeting solutions/ attributevalue /symbol allows you to retrieve a list of symbol attributes or a specific symbol attribute value. If trying to get a specific symbol attribute, the request requires you to provide the attribute class to query as well as the attribute name and object (symbol).
A GET request targeting solutions/attributevalue/symbol will return a list of symbol attributes available to query provided in JSON format.
{
"links": {
"ZFXSourceCurrencies": "http://<web bridge>/<longview Identifier>/api/app/solutions/attributevalue/symbol/ZFXSourceCurrencies",
"ZFXRateType": "http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/symbol/ZFXRateType",
"ZFXTranslations": "http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/symbol/ZFXTranslations",
"ZFXOverrideRates": "http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/symbol/ZFXOverrideRates"
}
}
Possible Responses - symbol
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain a list of symbol attributes that are available to query Response header LVStatus: ok |
406 Not Acceptable | If the request specifies Accept in the request header that does not include application/json |
404 Not Found | If the attribute class specified is not valid. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
A GET request targeting solutions/attributevalue/symbol/<AttributeName>?object=<SymbolName> will return the value of the symbol attribute, provided in text/plain format.
Note: If you return the result to an object in application framework the attribute value will be stored in the _data property of the target object.
URI example
http://<web bridge>/
<Longview Identifier>/api/app/solutions/attributevalue
/symbol/ZGPNativeCurrency?object=Entity1
Example
CAD
Possible Responses – symbol/AttributeName
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the value of the requested attribute for the specified symbol object Response header LVStatus: ok |
400 Bad Request | If the OBJECT parameter is not specified |
406 Not Acceptable | If the request specifies Accept in the request header that does not include text/plain, text/* or */* |
404 Not Found | If either
|
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
GET solutions/attributevalue/system
A GET request targeting solutions/attributevalue/system allows you to retrieve a list of system attributes or a specific system attribute value. If trying to get a specific system attribute, the request requires you to provide the attribute class to query as well as the attribute name and object (dbdefault).
A GET request targeting solutions/attributevalue/system will return a list of system attributes available to query provided in JSON format.
Example
{
"links": {
"SGPMaxDims": "http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/system/SGPMaxDims",
"SGPDimensionDefaults": "http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/system/SGPDimensionDefaults",
"SGPAccountsDimension": "http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/system/SGPAccountsDimension"
}
}
Possible Responses - system
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain a list of system attributes that are available to query Response header LVStatus: ok |
406 Not Acceptable | If the request specifies Accept in the request header that does not include application/json |
404 Not Found | If the attribute class specified is not valid. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
A GET request targeting solutions/attributevalue/system/<AttributeName>?object=dbdefault will return the value of the system attribute, provided in text/plain format.
Note: If you return the result to an object in application framework the attribute value will be stored in the _data property of the target object.
URI example
http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/system/SGPCurrentPeriod?object=dbdefault
Example
A20_09_YTD
Possible Responses – system/AttributeName
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the value of the requested attribute for the specified system object Response header LVStatus: ok |
400 Bad Request | If the object parameter is not specified |
406 Not Acceptable | If the request specifies Accept in the request header that does not include text/plain, text/* or */* |
404 Not Found | If either
|
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
GET solutions/attributevalue/user
A GET request targeting solutions/ attributevalue /user allows you to retrieve a list of user attributes or a specific user attribute value. If trying to get a specific user attribute, the request requires you to provide the attribute class to query as well as the attribute name and object (user ID).
A GET request targeting solutions/attributevalue/user will return a list of user attributes available to query provided in JSON format.
Example
{
"links": {
"UGPD0QueryDefault": "http://<web bridge>/<LONGVIEW IDENTIFIER>/api/app/solutions/attributevalue/user//UGPD0QueryDefault",
"UGPD1QueryDefault": "http://<web bridge>/<LONGVIEW IDENTIFIER>/api/app/solutions/attributevalue/user//UGPD1QueryDefault",
"UGPD2QueryDefault": "http://<web bridge>/<LONGVIEW IDENTIFIER>/api/app/solutions/attributevalue/user//UGPD2QueryDefault",
"UGPD3QueryDefault": "http://<web bridge>/<LONGVIEW IDENTIFIER>/api/app/solutions/attributevalue/user//UGPD3QueryDefault",
"UGPD4QueryDefault": "http://<web bridge>/<LONGVIEW IDENTIFIER>/api/app/solutions/attributevalue/user//UGPD4QueryDefault"
}
}
Possible Responses - user
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain a list of user attributes that are available to query Response header LVStatus: ok |
406 Not Acceptable | If the request specifies Accept in the request header that does not include application/json |
404 Not Found | If the attribute class specified is not valid. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
A GET request targeting solutions/attributevalue/user/<AttributeName>?object=<USERID> will return the value of the user attribute, provided in text/plain format.
Note: If you return the result to an object in application framework the attribute value will be stored in the _data property of the target object.
URI example
http://<web bridge>/<Longview Identifier>/api/app/solutions/attributevalue/user/ UGPD0QueryDefault?object=JSMITH
Example
TB
Possible Responses – user/AttributeName
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the value of the requested attribute for the specified user Response header LVStatus: ok |
400 Bad Request | If the OBJECT parameter is not specified |
406 Not Acceptable | If the request specifies Accept in the request header that does not include text/plain, text/* or */* |
404 Not Found | If either
|
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
GET solutions/data
A GET request targeting solutions/data allows you to retrieve data in csv format. The request requires you to provide the area to retrieve data from by supplying the symbol to query for each dimension in your database.
The content type returned by this request is text/csv. Each line in the response contains a field for each dimension in the database followed by a value. The first line is a header indicating what each field represents.
In addition, optional parameters allow you control the data returned in the request. The (DEFAULT) is used if the query parameter is not included in the request:
- What data to retrieve via the dataOption query parameter
- (DEFAULT) STANDARDALL – retrieves all parent and leaf data in the area specified
- STANDARDLEADONLY – retrieves leaf data in the area specified
- LEAFDATA – retrieve all leaf data in the area specified, excluding any calculated data
- Whether to retrieve unadjusted data only via the unadjusted query parameter
- (DEFAULT) false – retrieve adjusted data
- True – retrieve unadjusted data
- Whether to retrieve schedule data
- Schedule – name of the schedule to retrieve data from
URI example
http://<web server>/cgi-bin/LongviewClose/lvweb.cgi/LongviewClose/api/app/solutions/data?ACCOUNTS=ACCOUNTS_Input&TIMEPERIODS=TIMEPERIODS_Input&ENTITIES=ENTITIES_Input &DATAVIEWS=DATAVIEWS_Input&SCENARIOS=SCENARIOS_Input&CURRENCIES=CURRENCIES_Input &dataOption=LEAFDATA&schedule=NCI
Restrictions
The following restrictions apply to this request:
- Each dimension parameter specifies a single symbol name
- Hierarchical specifications are not supported, and all queries are executed as #99
- When a schedule is specified all symbols in each dimension of the schedule are included in the query
Possible Responses
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the data retrieved in media type text/csv Response header LVStatus: ok |
400 Bad Request | Caused by the following:
|
406 Not Acceptable | If the request specifies Accept in the request header that does not include text/csv |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
Additional Response Headers
Additional response headers are included in the response.
Header | Use |
|---|---|
Record-Count | The number of records in the response body, including the header. |
PUT solutions/data
A PUT request targeting solutions\data allows you to import data in csv format. The request requires you to provide the area to import data to by supplying the symbol to query for each dimension in your database.
The content type allowed to be imported is text/csv. Each line should contain a field for each dimension followed by a value. A header row is not required but can be used and ignored during import.
In addition, optional parameters allow you to control how the data is imported. The (DEFAULT) is used if the query parameter is not included in the request:
- Whether to update schedule data
- Schedule – name of the schedule to update
- How many records to ignore via headerRecords or footerRecords
- (DEFAULT) Blank – Doesn’t ignore any records
- Numerical value of number of records to be ignored
- Using header will count from top to bottom
- Using footer will count from bottom to top
URI example
http://<web server>/cgi-bin/LongviewClose/lvweb.cgi/LongviewClose/api/app/solutions/data?ACCOUNTS=ACCOUNTS_Input&TIMEPERIODS=TIMEPERIODS_Input&ENTITIES=ENTITIES_Input &DATAVIEWS=DATAVIEWS_Input&SCENARIOS=SCENARIOS_Input&CURRENCIES=CURRENCIES_Input &dataOption=LEAFDATA&schedule=NCI&headerRecords=1
Restrictions
The following restrictions apply to this request:
- Each dimension parameter specifies a single symbol name
- Hierarchical specifications are not supported, and all queries are executed as #99
- Import is always done FULL and not INCREMENTAL
- When a schedule is not specified, BASE data is submitted.
- If a schedule is specified, it must be the last field in the body before the data value
- Max Errors is set to 0
Possible Responses
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain information about the import:
Response header LVStatus: ok |
400 Bad Request | Caused by the following:
|
404 Not Found | If the request contains invalid symbols. |
415 Unsupported Media Type | PUT requires a text/csv file, if any other file type is used this will be the error that returns |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
Additional Response Headers
Additional response headers are included in the response.
Header | Use |
|---|---|
Records-Read | The number of records that were read on import |
Records-Filtered | The number of records that were filtered out from being imported |
Records-Rejected | The number of invalid records that were rejected from being imported |
GET data template
A GET request targeting solutions/data/<name> allows you to retrieve data in csv format.
<name> is the name of the API configuration file created using the API Data GET templates.
The request requires you to provide the name of the API configuration file that contains the data spec definition and export spec definition that define how the data will be exported.
Available templates:
- Data GET – Single Value
- Data GET – Multiple Values
For more information on the Data GET templates, see the Creating data get APIs in the Longview Designer Guide.
In addition, optional parameters for dimension symbols can be passed to allow you control the intersection defined in the request.
URI example
http://<web server>/cgi-bin/LongviewClose/lvweb.cgi/LongviewClose/api/app/solutions/data/TrialBalanceData?TIMEPERIODS=A20_12_YTD
The content type returned by this request is text/csv.
Possible Responses
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the export log generated in media type text/plain. Response header LVStatus: ok |
404 Not Found | If the API configuration file created using the API Data GET template in the URI does not exist. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred. Response header LVStatus: error |
PUT data template
A PUT request targeting solutions/data/<name> allows you to submit data in csv format.
<name> is the name of the API configuration file created using the API Data PUT templates.
The request requires you to provide the name of the API configuration file that contains the data spec definition and import spec definition that define how the data will be imported.
Available templates:
- Data PUT – Single Value
- Data PUT – Multiple Values
For more information on the Data PUT templates, see the Creating data put APIs in the Longview Designer Guide.
In addition, optional parameters for dimension symbols can be passed to allow you control the intersection defined in the request.
URI example
http://<web server>/cgi-bin/LongviewClose/lvweb.cgi/LongviewClose/api/app/solutions/data/LoadTrialBalance?TIMEPERIODS=A20_12_YTD
The content type returned by this request is text/plain.
Possible Responses
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the import log generated in media type text/plain. Response header LVStatus: ok |
404 Not Found | If the API configuration file created using the API Data PUT template specified in the URI does not exist. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain media in text/plain with an execution error that occurred or a list of records with submission errors up to the maximum error count per the API Library. Response header LVStatus: error |
GET hierarchies
A GET request targeting solutions/hierarchies allows you to retrieve hierarchy structure information in text format. The request requires you to provide the dimension to query as well as the root symbol within that dimension to extract hierarchy information from.
A GET request targeting solutions/hierarchies will return a list of dimensions available to query provided in JSON format.
Example
{
"links": {
"ACCOUNTS": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/ACCOUNTS",
"TIMEPERIODS": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/TIMEPERIODS",
"ENTITIES": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/ENTITIES",
"DATAVIEWS": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/DATAVIEWS",
"COST_CENTRES": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/COST_CENTRES",
"PRODUCTS": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/PRODUCTS",
"SCENARIOS": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/SCENARIOS",
"CURRENCIES": "http://<web bridge>/<Longview identifier>/api/app/solutions/hierarchies/CURRENCIES"
}
}
Possible Responses
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the import log generated in media type text/plain. Response header LVStatus: ok |
404 Not Found | If the API configuration file created using the API Data PUT template specified in the URI does not exist. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain media in text/plain with an execution error that occurred or a list of records with submission errors up to the maximum error count per the API Library. Response header LVStatus: error |
Possible Responses – hierarchies/<Dimension>
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain list of root symbols within the dimension provided that are available to query Response header LVStatus: ok |
404 Not Found | If the dimension specified is not valid. |
406 Not Acceptable | If the request specifies Accept in the request header that does not include application/json |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
A GET request targeting solutions/hierarchies/<dimension name>/<root symbol> will return a hierarchy structure export of the root symbol provided in plain text format.
URI example
http://<web server>/cgi-bin/LongviewClose/lvweb.cgi/LongviewClose/api/app/solutions/hierarchies/ACCOUNTS/TB
Return example
{TB{{Trial balance{Standard{Dynamic{Manual{Neither
TB{BS{0{Balance sheet{CarryForward{Dynamic{Manual{Debit{100
BS{TA0000{+{Assets{CarryForward{Dynamic{Manual{Debit{100
TA0000{TestBalSheet{-{TestBalSheet{CarryForward{Auto{Manual{Credit{50
TA0000{TA1000{+{Non-current assets{CarryForward{Dynamic{Manual{Debit{1000
TA1000{TA1010{+{Property, plant and equipment{CarryForward{Dynamic{Manual{Debit{1010
TA1010{12100{+{Land{CarryForward{Auto{Manual{Debit{12100
TA1010{12110{+{Buildings{CarryForward{Auto{Manual{Debit{12110
TA1010{12115{+{Buildings, depreciation{CarryForward{Auto{Manual{Debit{12115
TA1010{12119{+{Buildings, impairment{CarryForward{Auto{Manual{Debit{12119
TA1010{12150{+{Manufacturing equipment{CarryForward{Auto{Manual{Debit{12150
TA1010{12155{+{Manufacturing equipment, depreciation{CarryForward{Auto{Manual{Debit{12155
TA1010{12159{+{Manufacturing equipment, impairment{CarryForward{Auto{Manual{Debit{12159
TA1000{TA1020{+{Investment property{CarryForward{Auto{Manual{Debit{1020
TA1000{TA1030{+{Goodwill{CarryForward{Auto{Manual{Debit{1030
TA1000{TA1040{+{Intangible assets other than goodwill{CarryForward{Auto{Manual{Debit{1040
TA1000{TA1050{+{Investments accounted for using equity method{CarryForward{Dynamic{Manual{Debit{1050
TA1050{12400{+{Investment in associates{CarryForward{Auto{Manual{Debit{12400
TA1050{12410{+{Share of Profit in Associates{CarryForward{Auto{Manual{Debit{12410
Possible Responses – hiérarchies/<Dimension>/<Root Symbol>
Status | Notes |
|---|---|
200 OK (OK) | The response body will contain the exported root structure hierarchy in text plain format Response header LVStatus: ok |
400 Bad Request | If the Root symbol specified is not actually a root level in the dimension specified |
404 Not Found | Caused by the following:
|
406 Not Acceptable | If the request specifies Accept in the request header that does not include text/plain, text/* or */* |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
PUT hierarchies
A PUT request targeting solutions/hierarchies allows you to update a hierarchy in the Longview database. The request requires you to provide the dimension to update as well as the root symbol within that dimension that you wish to update the hierarchy for.
A PUT request targeting solutions/hierarchies or targeting solutions/hierarchies/<dimension name> is not supported and will return 405 Method Not Allowed error.
Possible Responses - <Dimension>
Status | Notes |
|---|---|
404 Not Found | If the dimension specified is not valid. |
405 Method Not Allowed | PUT is not a supported method for the URI request. |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |
A PUT request targeting solutions/hierarchies/<dimension name>/<root symbol> will allow updating that root hierarchy structure. The content type allowed is text/plain. The format of the file is the same as the format outputted when running a GET request targeting solutions/hierarchies/<dimension name>/<root symbol>.
For more information on the syntax, see the SyncHier command in the Solutions Developer Guide.
In addition, optional parameters allow you to control how the hierarchy is updated. The (DEFAULT) is used if the parameter is not included in the request:
- The execute mode via the Execute parameter
- (DEFAULT) SIMULATE – Generates a plain text output file for each type of command that would be run but is not actually executed.
- True - Implements the instructions and commits the designated changes to the destination hierarchy.
- The Delete mode via the Delete parameter
- (DEFAULT) The symbols are not actually deleted, they are re-assigned to the <Dimension Name>_DELETED hierarchy structure.
- True – Signifies that the symbol will be completely removed from the database
URI example
http://<web server>/cgi-bin/LongviewClose/lvweb.cgi/LongviewClose/api/app/solutions/hierarchies/ACCOUNTS/TB
Body example
{TB{{Trial balance{Standard{Dynamic{Manual{Neither
TB{BS{0{Balance sheet{CarryForward{Dynamic{Manual{Debit{100
BS{TA0000{+{Assets{CarryForward{Dynamic{Manual{Debit{100
TA0000{TestBalSheet{-{TestBalSheet{CarryForward{Auto{Manual{Credit{50
TA0000{TA1000{+{Non-current assets{CarryForward{Dynamic{Manual{Debit{1000
TA1000{TA1010{+{Property, plant and equipment{CarryForward{Dynamic{Manual{Debit{1010
TA1010{12100{+{Land{CarryForward{Auto{Manual{Debit{12100
TA1010{12110{+{Buildings{CarryForward{Auto{Manual{Debit{12110
TA1010{12115{+{Buildings, depreciation{CarryForward{Auto{Manual{Debit{12115
TA1010{12119{+{Buildings, impairment{CarryForward{Auto{Manual{Debit{12119
TA1010{12150{+{Manufacturing equipment{CarryForward{Auto{Manual{Debit{12150
TA1010{12155{+{Manufacturing equipment, depreciation{CarryForward{Auto{Manual{Debit{12155
TA1010{12159{+{Manufacturing equipment, impairment{CarryForward{Auto{Manual{Debit{12159
TA1000{TA1020{+{Investment property{CarryForward{Auto{Manual{Debit{1020
TA1000{TA1030{+{Goodwill{CarryForward{Auto{Manual{Debit{1030
TA1000{TA1040{+{Intangible assets other than goodwill{CarryForward{Auto{Manual{Debit{1040
TA1000{TA1050{+{Investments accounted for using equity method{CarryForward{Dynamic{Manual{Debit{1050
TA1050{12400{+{Investment in associates{CarryForward{Auto{Manual{Debit{12400
TA1050{12410{+{Share of Profit in Associates{CarryForward{Auto{Manual{Debit{12410
Possible Responses - <Dimension>/<Root Symbol>
Status | Notes |
|---|---|
200 OK (OK) | The response body will be empty Response header LVStatus: ok |
400 Bad Request | If the Root symbol specified is not actually a root level in the dimension specified |
404 Not Found | Caused by the following:
|
405 Method Not Allowed | PUT is not a supported method for the URI request. |
415 Unsupported Media Type | PUT requires a text/plain, text/* or */* content type. If any other file type is used this will be the error that returns |
200 OK (ERROR) | If any error occurs during the execution of the request. The response body will contain text/plain with the execution error that occurred Response header LVStatus: error |