Lease Management and UDF Field Retrieval¶

ID: UC-NRE-LEASES-W001
Complexity: Basic
Description: Retrieve lease information and associated user-defined field values using the NRE API
Scenario: A business user needs to retrieve lease information and associated user-defined field values for analysis and reporting purposes
Business Value: Enables comprehensive lease data retrieval and analysis, supporting lease management workflows and reporting requirements

Prerequisites¶

Valid API key for NRE API
Access to NRE API environment
Lease ID for existing lease

Steps¶

1. Retrieve Specific Lease Details¶

Get detailed information about a specific lease by ID

Endpoint: GET /api/leases/{id}

HTTP Request

curl -X GET 'https://{base-url}/api/leases/{id}' 
  -H 'x-api-key: YOUR_API_KEY' 
  -H 'Content-Type: application/json'

Expected Response: HTTP 200 with lease details

Notes: Replace {id} with the actual lease ID. This step retrieves basic lease information

2. Retrieve UDF Field Values¶

Get user-defined field values for a specific lease

Endpoint: GET /api/leases/{id}/udf-field-values

HTTP Request

curl -X GET 'https://{base-url}/api/leases/{id}/udf-field-values' 
  -H 'x-api-key: YOUR_API_KEY' 
  -H 'Content-Type: application/json'

Expected Response: HTTP 200 with UDF field values

Notes: Replace {id} with the actual lease ID. This step retrieves custom field values associated with the lease

Error Scenarios¶

Lease does not exist (404): Verify that the lease ID exists and you have access permissions Recovery: Check lease ID validity and ensure proper authorization

Access to this API has been disallowed (403): Verify that your API key has the necessary permissions Recovery: Contact the support team to grant appropriate permissions

Rate Limiting (429): Implement exponential backoff and retry mechanisms Recovery: Add delays between requests and respect rate limits

Best Practices¶

Implement proper error handling for missing leases
Cache frequently accessed lease data
Validate lease IDs before making requests
Handle empty UDF values gracefully
Implement retry logic for failed requests