AvantGuard - Pax8 - Vendor Provisioning icon

AvantGuard - Pax8 - Vendor Provisioning

AvantGuard - Pax8

Overview

The node "Create Provision Result" under the "Provision Results" resource is designed to send provisioning result data to an external API endpoint. It allows users to create a new provision result record by specifying key details such as the associated provision request ID and the status of the provisioning operation. This node is useful in automation workflows where tracking or reporting the outcome of provisioning requests is necessary, for example, after attempting to provision cloud resources, licenses, or subscriptions via a vendor's API.

Practical examples include:

  • Reporting the success or failure status of a subscription provisioning attempt.
  • Logging error messages when provisioning fails.
  • Associating external identifiers related to the provisioning process for audit or reconciliation purposes.

Properties

Name Meaning
Provision Request Id The unique identifier of the provision request this result relates to.
Status The current status of the provisioning result (e.g., success, failed).
Additional Body Fields Optional additional fields that can be included in the request body:
- Id An optional identifier for the provision result itself.
- Provision Attempt Id Identifier for the specific attempt of provisioning.
- Error Message A message describing any error encountered during provisioning.
- External Provisioner Subscription Id External system's subscription identifier related to the provisioning.
- External Provisioner Partner Id External partner identifier involved in provisioning.
- External Provisioner Company Id External company identifier related to provisioning.
- External Provisioner Partner Enrollment Id External enrollment identifier for the partner in provisioning.

Output

The node outputs JSON data representing the response from the API after creating the provision result. This typically includes confirmation details of the created provision result record, such as its ID and status. The output does not explicitly handle binary data.

Dependencies

  • Requires an API key credential for authenticating with the external Pax8 Vendor Provisioning API.
  • The base URL for API requests is https://api.pax8.com/v2.
  • The node uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Missing required fields like "Provision Request Id" or "Status" will likely cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing invalid values in optional fields may cause the API to reject the request.
  • Error messages:

    • Authentication errors: Check that the API key credential is correctly configured and valid.
    • Validation errors: Ensure all required properties are provided and conform to expected formats.
    • Network errors: Verify network connectivity and that the API endpoint is reachable.

Links and References

Discussion