> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sign-Off REST endpoints

## Quick Navigation

[Supported Adjustments](#Supported_Adjustments)\
[Adjustment Execution](#Adjustment_Execution)\
[Adjustment Deletion](#Adjustment_Deletion)\
[Execution Status](#Execution_Status)

## <a name="Supported_Adjustments" />Supported Adjustments

Endpoint: `/adjustments/supported`\
Method : `GET`\
Example endpoint: [http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/supported](http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/supported)

Result is a serialized array of `SupportedAdjustmentDTOs`

Example Result:

```JSON theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
{
  "status": "success",
  "data": "[{\"name\":\"Roll over\",\"type\":\"SENSI_ROLL_OVER\",\"factLevel\":false,\"cube\":\"Sensitivity Cube\",\"stores\":[\"TradeSensitivities\"],\"filters\":[{\"name\":\"Status\",\"type\":\"path\",\"optional\":true,\"levelPath\":\"[Sign-off Status].[Sign-off Status].[Status]\"},{\"name\":\"TradeId\",\"type\":\"string\",\"optional\":true,\"levelPath\":\"[Booking].[Trades].[TradeId]\"},{\"name\":\"Book\",\"type\":\"string\",\"optional\":true,\"levelPath\":\"[Booking].[Books].[Book]\"},{\"name\":\"Input type\",\"type\":\"path\",\"optional\":true,\"levelPath\":\"[Sign-off Adjustments].[Source].[Input type]\"},{\"name\":\"Desk\",\"type\":\"string\",\"optional\":false,\"levelPath\":\"[Booking].[Desks].[Desk]\"},{\"name\":\"Task\",\"type\":\"path\",\"optional\":true,\"levelPath\":\"[Sign-off Status].[Sign-off Status].[Task]\"},{\"name\":\"AsOfDate\",\"type\":\"localDate[yyyy-MM-dd]\",\"optional\":false,\"levelPath\":\"[Dates].[Date].[AsOfDate]\"},{\"name\":\"Source\",\"type\":\"path\",\"optional\":true,\"levelPath\":\"[Sign-off Adjustments].[Source].[Source]\"}],\"measures\":null,\"input\":[{\"name\":\"AsOfDate\",\"type\":\"localDate[yyyy-MM-dd]\",\"optional\":false}]}}]"
}
```

## <a name="Adjustment_Execution" />Adjustment Execution

Endpoint: `/adjustments/execute`\
Method : `POST`\
Example endpoint: [http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/execute](http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/execute)

Body is a serialized `AdjustmentRequestDTO`

Example Body:

```JSON theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
{
   "key":"PNL_ADD_ON",
   "user":"User",
   "task":"Task",
   "filters":[
      {
         "name":"AsOfDate",
         "value":"2018-09-28"
      },
      {
         "name":"TradeId",
         "value":"CDS_Allegheny Energy 3cc00452"
      },
      {
         "name":"Type",
         "value":"Actual PL Attributed"
      },
      {
         "name":"RiskFactor",
         "value":"Allegheny Energy_Credit spread"
      }
   ],
   "measures":[
      "DTD PnL Native"
   ],
   "input":
      [
         {
            "name":"Daily",
            "value":"10000.0"
         }
      ]
}
```

Result is the execution ID

Example Result:\
`"PNL_ADD_ON_0"`

## <a name="Adjustment_Deletion" />Adjustment Deletion

Endpoint: `/adjustments/delete`\
Method : `POST`\
Example endpoint: [http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/delete](http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/delete)

Body is a serialized `AdjustmentDeletionRequestDTO`

Example Body:

```JSON theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
{
   "user":"User",
   "taskId":"Task",
   "executionIds":
      [
         "PNL_ADD_ON_0",
         "PNL_SCALING_1"
      ]
}
```

Result is the execution ID

Example Result:\
`"PNL_DELETION_0"`

## <a name="Execution_Status" />Execution Status

Endpoint: `adjustments/executionStatus?executionId=<_execution_Id_> `\
Method : `GET`\
Example endpoint: [http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/executionStatus?executionId=PNL\_ADD\_ON\_0](http://localhost:10010/risk-activepivot/services/rest/v3/adjustments/executionStatus?executionId=PNL_ADD_ON_0)

Example Result:

```JSON theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
{
    "status": "success",
    "data": "\"FAILED\""
}
```
