Lock and Unlock POV

The lock REST API prevents data from being loaded to a selected POV by location or application associated with a current period and category.

When a location or application has been locked, you cannot import, validate, export, or rerun a validation.

An unlock RESP API is available so that you can unlock a locked location or application.

Prerequisites:

You must have Service Administrator privileges to execute the lock and unlock REST APIs.

REST Resource

/aif/rest/V1/POV

Required Roles

Service Administrator, Power User

Method:

POST

Lock/Unlock by Location RESP API Request Parameters

The following table summarizes the request parameters for locking by location:

Table 11-7 Parameters

Name Description Type Required Default
api_version V1 Path Yes None
category

Specify the predefined Scenario value based on the POV Category from the integration (data rule) definition.

The categories available are those that are created in the Data Management set-up, such as "Actual."

JSON payload Yes None
period

Specify the period of the POV from the integration or data load rule defined in Data Management.

JSON payload Yes None
location

Specify the name of the location to lock so that data cannot be loaded to it.

JSON payload Yes None
locktype

Specify location for the location lock type.

JSON payload Yes None
operation

For a lock operation, specify lock.

For an unlock operation, specify unlock.

JSON payload Yes None

JSON Request Payload to Lock Location Example:

{
"category": "Actual",
"period": "Jan-17",
"location": "FCCSAPP1_LOC1A",
"locktype":"location"
"operation": "lock"
}

Response to Locking a Location Example:

{
"details":",
"status": 0,
"response": "Location:FCCSAPP1_LOC1A has been locked successfully."
}

JSON Request Payload to Unlock Location Example:

{
"category": "Actual",
"period": "Jan-17",
"location": "FCCSAPP1_LOC1A",
"locktype":"location"
"operation":"unlock"
}

Response to Unlocking a Location Example:

The following is an example of unlocking a location REST API response.

{
"details":",
"status": 0,
"response":"Location:FCCSAPP1_LOC1A has been unlocked successfully."
}

Lock/Unlock by Application REST API Request Parameters

Name Description Type Required Default
api_version V1 Path Yes None
category

Specify the predefined "Scenario" value based on the POV Category from the integration (data rule) definition.

The categories available are those that were created in the Data Management set-up, such as"Actual".

JSON payload Yes None
period

Specify the period of the POV from the integration or data load rule defined in Data Management.

JSON payload Yes None
application

Specify the name of the application to lock so that data cannot be loaded to it.

JSON payload Yes None
locktype

Specify application for the application lock type.

JSON payload Yes None
unlockbylocation

true/false—Boolean option for whether to unlock by location when an application is locked.

If the "unlockbylocation" flag is set to "true" when locking the target application, then the system locks all rules present in the location under target application and not the application level lock.

If the "unlockbylocation" flag is set to "false" when locking the target application, then the system locks all rules present in the location under the target application and the application level lock.

Rules present for locations in the application cannot be executed when the location is unlocked until the application level lock is removed. Furthermore, when you create a new location under the locked target application, rules can’t be executed in the new location until the application level lock is removed.

JSON payload No false
operation

For a lock operation, specify lock.

For an unlock operation, specify unlock.

JSON payload Yes None

JSON Request Payload to Lock an Application Example:

{
"category": "Actual",
"period": "Jan-17",
"application": "FCCSAPP1",
"locktype":"application",
"operation": "lock"
}

Response to Locking an Application Example:

The following is an example of locking an application REST API response.

{
"details":null,
"status": 0,
"response":"Application: FCCSAPP1 has been locked successfully."
}

JSON Request Payload to Unlock a Location for a Locked Application Example:

{
"category": "Actual",
"period": "Jan-17",
"application": "FCCSAPP1",
"locktype":"application",
"unlockbylocation":"true",
"operation": "lock"
}

Response to Unlocking a Location for a Locked Application Example:

The following is an example of unlocking a location when locking an application REST API response.

{
"details":null,
"status": 0,
"response":"Application: FCCSAPP1 has been locked successfully."
}