create_equipment_note.py

#!/usr/bin/env python
"""create_equipment_note.py: A working example of how to create an equipment
note that has 1 file attachment.

An upload session is first created for the file to be uploaded. The file
is uploaded to Raptor Maps cloud storage, a note is created for the specific 
piece of equipment with a title and description, and finally the file
is associated to the note.

This script requires specifying the solar farm id and the equipment id.

Example:

> python create_equipment_note.py
"""

__copyright__ = "Raptor Maps Inc. 2023 (c)"

import json
import os
import requests
import sys

RM_API = 'https://api.raptormaps.com'
RM_LEGACY_API = 'https://app-legacy.raptormaps.com'

def main():

    # INPUTS: change these!
    solar_farm_id = 123
    object_id = 123
    note_title = 'Test note'
    note_description = 'Test description'
    filepath = '/path/to/my/file/to/upload.jpg'

    # API Authentication:
    # Set API token from environment variables
    api_access_token = os.environ.get('RM_API_TOKEN_PROD')

    # Set org id which can be found at https://app.raptormaps.com/account
    org_id = os.environ.get('RM_ORG_ID')

    # If you do not already have an API token, this code snippet will get one
    # See here for more info: https://docs.raptormaps.com/reference/reference-getting-started
    if not api_access_token:
        client_id = os.environ['RM_API_CLIENT_ID']
        client_secret = os.environ['RM_API_CLIENT_SECRET']
        token_endpoint = 'https://login.raptormaps.com/oauth/token'
        token_endpoint_headers = {
            'content-type': 'application/json'
        }
        token_endpoint_body = {
            'client_id': client_id,
            'client_secret': client_secret,
            'grant_type': 'client_credentials',
            'audience': 'api://customer-api.v2'
        }

        token_response = requests.post(
            token_endpoint,
            headers=token_endpoint_headers,
            data=json.dumps(token_endpoint_body))

        response_data = token_response.json()

        api_access_token = response_data.get('access_token')

        print(f'Store this secret api token in your env variables: {api_access_token}')
        sys.exit()


    # Get information about the file to upload
    filename = os.path.basename(filepath)
    filesize = os.path.getsize(filepath) # in bytes

    # Setup header for API requests
    headers = {
        'Authorization': f'Bearer {api_access_token}',
        'Content-Type': 'application/json'
    }

    # Create note
    note_endpoint = f'{RM_API}/solar_farms/{solar_farm_id}/equipment/{object_id}/notes?org_id={org_id}'
    note_payload = {
        "title": note_title,
        "body": note_description
    }
    note_resp = requests.post(
        url=note_endpoint,
        headers=headers,
        data=json.dumps(note_payload)
    )
    note = note_resp.json()
    note_id = note.get('id')

    # If you do not want to upload a file, you can stop here

    # Create upload session for file
    upload_session_endpoint = f'{RM_LEGACY_API}/api/v2/feature_upload_session?org_id={org_id}'
    upload_session_payload = {
        'file_total': 1
    }
    upload_session_resp = requests.post(
        url=upload_session_endpoint,
        headers=headers,
        data=json.dumps(upload_session_payload)
    )
    upload_session = upload_session_resp.json()
    upload_session_id = upload_session.get('upload_session').get('id')

    # Create cloud storage location for file upload
    s3_link_endpoint = f'{RM_LEGACY_API}/api/v2/feature_upload_session/s3_link?org_id={org_id}'
    s3_link_payload = {
        "upload_session_id": upload_session_id,
        "filename": filename,
        "filesize": filesize
    }
    s3_link_resp = requests.post(
        url=s3_link_endpoint,
        headers=headers,
        data=json.dumps(s3_link_payload)
    )
    s3_link = s3_link_resp.json()
    file_id = s3_link.get('file_id')
    s3_post = s3_link.get('post')

    # Upload file to cloud storage
    with open(filepath, 'rb') as f:
        files = {'file': (filename, f)}
        s3_post_resp = requests.post(
            url=s3_post['url'],
            data=s3_post['fields'],
            files=files
        )
    # Status code 204 indicates a successful upload
    print(f'File upload HTTP status code: {s3_post_resp.status_code}')

    # Associate file to note
    note_files_endpoint = f'{RM_API}/solar_farms/{solar_farm_id}/equipment/{object_id}/notes/{note_id}/files?org_id={org_id}'
    note_files_payload = {
        "files": [{
            "file_id": file_id,
            "file_name": filename
        }]
    }
    note_files_resp = requests.post(
        url=note_files_endpoint,
        headers=headers,
        data=json.dumps(note_files_payload)
    )

    if note_files_resp.status_code == 200:
        print(f'Congrats! {filename} is associated to object id {object_id}!')
    else:
        print('Error: Note files status code: {note_files_resp.status_code}')

if __name__ == '__main__':
    main()