You use Property Manager API (PAPI) to manage both property and include data. You use this API to manage access to both, such as by positioning them where you want in the account's group hierarchy.
Independently manage includes
You may have several teams on the account, all responsible for various parts of a property's rule tree with a different group or role for each property. You can use includes to divide work among those teams. For example, when you create new properties or includes, you can specify a particular groupId
for each, then use this API to move either around later. See includes for more information on this Property Manager feature.
Resolve this API's property IDs with PAPI
Suppose you have a property or an include you can access in this API. Perhaps you want to look at its data in PAPI, such as its rules or the hostnames it applies to. You may want to look into this before performing an operation on it in this API, such as moving it to another group or accessing its users.
Properties in this API actually refer to both properties and includes in PAPI. What appears as propertyId
in this API's data refers to secondary assetId
keys in both property and include data in PAPI.
To get a PAPI property or an include from this API:
-
Run the Get a property operation for the property you want to research. What this API calls a property may be either a property or an include in PAPI.
-
Store the
propertyName
value from the response data. -
In the Property Manager API, run the Search properties or includes operation. Provide the
propertyName
key and its value in the request object.Example:
{ "propertyName": "abc-dn123-abcde.akamaiorigin.net" }
-
If the
propertyName
corresponds to an include, the response yields an emptyitems
value. Repeat the previous step, but instead provide theincludeName
key and the samepropertyName
value in the request object.Example:
{ "includeName": "abc-dn123-abcde.akamaiorigin.net" }
-
Either way, the response yields data whose
propertyId
orincludeId
values key data within Property Manager. You can get the specificpropertyVersion
orincludeVersion
active on the staging or production network. Use this pair of ID and version values to run the Get a property version, or Get an include version operations.
Resolve PAPI's property or include IDs with this API
If you want to manage access to any properties or includes available in PAPI, use this procedure to key the data:
-
Run PAPI's Get a property or Get an include operation.
-
Store the
assetId
value from the response data. Note that theseassetId
values all appear in this API's data aspropertyId
, regardless of whether they represent properties or includes in PAPI. -
Strip out any
aid_
string prefix from theassetId
value. To prevent these prefixes from appearing, read about PAPI's system of ID prefixes. -
Use PAPI's
assetId
value in this API's Get a property operation, or any other operation keyed by anassetId
value. Note that theseassetId
values all appear in this API data aspropertyId
.