Admin Arrow Customer Mappings
Operations Summary
Core CRUD
Customer mappings
Retrieve
Data Retrieval
Available customers
Get available Arrow customers that are not yet mapped, with suggestions for Waldur organization matches.
Get billing and consumption summary for this customer mapping
Get billing and consumption summary for this customer mapping.
Discover Arrow licenses for this customer and show linkable Waldur resources
Discover Arrow licenses for this customer and show linkable Waldur resources.
Fetch fresh consumption and billing data from Arrow API for this customer
Fetch fresh consumption and billing data from Arrow API for this customer.
Sync & Management
Import an Arrow license as a new Waldur resource
Import an Arrow license as a new Waldur resource.
| http \
POST \
https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/import_license/ \
Authorization:"Token YOUR_API_TOKEN" \
license_reference="string-value" \
offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.import_license_request_request import ImportLicenseRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_import_license # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = ImportLicenseRequestRequest(
license_reference="string-value",
offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_customer_mappings_import_license.sync(
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
client=client,
body=body_data
)
print(response)
|
- Model Source:
ImportLicenseRequestRequest
- API Source:
admin_arrow_customer_mappings_import_license
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | import { adminArrowCustomerMappingsImportLicense } from 'waldur-js-client';
try {
const response = await adminArrowCustomerMappingsImportLicense({
auth: "Token YOUR_API_TOKEN",
path: {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
body: {
"license_reference": "string-value",
"offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"project_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Required |
uuid |
string (uuid) |
✓ |
| Field |
Type |
Required |
Description |
license_reference |
string |
✓ |
Arrow license reference (e.g., XSP12345). Will be set as backend_id. |
license_name |
string |
|
Name for the new resource. Defaults to license_reference if not provided. |
offering_uuid |
string (uuid) |
✓ |
UUID of the Waldur offering to create the resource under. |
project_uuid |
string (uuid) |
✓ |
UUID of the project to create the resource in. |
200 -
| Field |
Type |
resource_uuid |
string (uuid) |
resource_name |
string |
license_reference |
string |
offering_name |
string |
project_name |
string |
success |
boolean |
Link a Waldur resource to an Arrow license by setting its backend_id
Link a Waldur resource to an Arrow license by setting its backend_id.
| http \
POST \
https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/link_resource/ \
Authorization:"Token YOUR_API_TOKEN" \
resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
license_reference="string-value"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.link_resource_request_request import LinkResourceRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_link_resource # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = LinkResourceRequestRequest(
resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
license_reference="string-value"
)
response = admin_arrow_customer_mappings_link_resource.sync(
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
client=client,
body=body_data
)
print(response)
|
- Model Source:
LinkResourceRequestRequest
- API Source:
admin_arrow_customer_mappings_link_resource
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 | import { adminArrowCustomerMappingsLinkResource } from 'waldur-js-client';
try {
const response = await adminArrowCustomerMappingsLinkResource({
auth: "Token YOUR_API_TOKEN",
path: {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
body: {
"resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"license_reference": "string-value"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Required |
uuid |
string (uuid) |
✓ |
| Field |
Type |
Required |
Description |
resource_uuid |
string (uuid) |
✓ |
UUID of the Waldur resource to link. |
license_reference |
string |
✓ |
Arrow license reference to set as backend_id (e.g., XSP12345). |
200 -
| Field |
Type |
resource_uuid |
string (uuid) |
resource_name |
string |
license_reference |
string |
previous_backend_id |
string |
success |
boolean |
Sync customer list from Arrow and update arrow_company_name
Sync customer list from Arrow and update arrow_company_name.
Other Actions
Customer mappings
| http \
POST \
https://api.example.com/api/admin/arrow/customer-mappings/ \
Authorization:"Token YOUR_API_TOKEN" \
settings="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
arrow_reference="string-value" \
waldur_customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_customer_mapping_create_request import ArrowCustomerMappingCreateRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_create # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = ArrowCustomerMappingCreateRequest(
settings="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
arrow_reference="string-value",
waldur_customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_customer_mappings_create.sync(
client=client,
body=body_data
)
print(response)
|
- Model Source:
ArrowCustomerMappingCreateRequest
- API Source:
admin_arrow_customer_mappings_create
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 | import { adminArrowCustomerMappingsCreate } from 'waldur-js-client';
try {
const response = await adminArrowCustomerMappingsCreate({
auth: "Token YOUR_API_TOKEN",
body: {
"settings": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"arrow_reference": "string-value",
"waldur_customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Field |
Type |
Required |
Description |
settings |
string (uuid) |
✓ |
|
arrow_reference |
string |
✓ |
Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string |
|
Arrow company name |
waldur_customer |
string (uuid) |
✓ |
|
is_active |
boolean |
|
Whether this mapping is active |
201 -
| Field |
Type |
Description |
uuid |
string (uuid) |
|
url |
string (uri) |
|
settings |
string (uuid) |
|
settings_uuid |
string (uuid) |
|
arrow_reference |
string |
Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string |
Arrow company name |
waldur_customer |
string (uuid) |
|
waldur_customer_uuid |
string (uuid) |
|
waldur_customer_name |
string |
|
is_active |
boolean |
Whether this mapping is active |
created |
string (date-time) |
|
modified |
string (date-time) |
|
Update
| http \
PUT \
https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
Authorization:"Token YOUR_API_TOKEN" \
settings="https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
arrow_reference="string-value" \
waldur_customer="https://api.example.com/api/waldur-customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_customer_mapping_request import ArrowCustomerMappingRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_update # (2)
client = AuthenticatedClient(
base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
body_data = ArrowCustomerMappingRequest(
settings="https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
arrow_reference="string-value",
waldur_customer="https://api.example.com/api/waldur-customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = admin_arrow_customer_mappings_update.sync(
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
client=client,
body=body_data
)
print(response)
|
- Model Source:
ArrowCustomerMappingRequest
- API Source:
admin_arrow_customer_mappings_update
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | import { adminArrowCustomerMappingsUpdate } from 'waldur-js-client';
try {
const response = await adminArrowCustomerMappingsUpdate({
auth: "Token YOUR_API_TOKEN",
path: {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
body: {
"settings": "https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
"arrow_reference": "string-value",
"waldur_customer": "https://api.example.com/api/waldur-customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
}
});
console.log('Success:', response);
} catch (error) {
console.error('Error:', error);
}
|
| Name |
Type |
Required |
uuid |
string (uuid) |
✓ |
| Field |
Type |
Required |
Description |
settings |
string (uri) |
✓ |
|
arrow_reference |
string |
✓ |
Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string |
|
Arrow company name |
waldur_customer |
string (uri) |
✓ |
|
is_active |
boolean |
|
Whether this mapping is active |
200 -
| Field |
Type |
Description |
uuid |
string (uuid) |
|
url |
string (uri) |
|
settings |
string (uri) |
|
settings_uuid |
string (uuid) |
|
arrow_reference |
string |
Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string |
Arrow company name |
waldur_customer |
string (uri) |
|
waldur_customer_uuid |
string (uuid) |
|
waldur_customer_name |
string |
|
is_active |
boolean |
Whether this mapping is active |
created |
string (date-time) |
|
modified |
string (date-time) |
|
Partial Update
Delete