Skip to content

Updating OAID

Update - Update Attributes

During the lifecycle of an OAID, and specifically after confirming (CONFIRM) an OAID, there may be changes to make on the attributes. Updates can be done using a PATCH Request. The API follows some simple underlying principles: Each attribute called in the request overwrites the values stored in the register. Attributes that should retain their value should not be included.

Warning

If an attribute is submitted with none, it will be saved as none in the register.

$ curl --request PATCH --location "https://api.oaid.at/v1/pip/codes/ABCD1234/"  \
$  --header "Authorization: Bearer <access_token>" \
$  --header "Accept: application/json" \
$  --header "Content-Type: application/json" \
$  --data '{
    "business_key": "ext.87654321", 
    "center": "48.19404,15.64005",
    "attr": { "mode": 13, "port_type": "STZ 13.3" }
}'
---> 100%
{
    "tenant": "fiberpark",
    "code": "ABCD1234",
    "token": "confirmed",
    "version": "v8",
    "status": "started",
    "external_id": "7710fb1e-0efb-42af-9e30-ed46188d9bb9",
    "created_at": "2022-03-01T10:35:03.392+01:00",
    "modified_at": "2022-03-01T10:38:03.844+01:00",
    "_links": {
        "self": "https://api.oaid.at/v1/pip/codes/ABCD1234/"
    },
    "business_key": "ext.87654321",
    "center": "48.19404,15.64005",
    "attr": {
        "mode": 13,
        "port_type": "STZ 13.3"
    }
}