.. AUTO-GENERATED FILE. DO NOT EDIT.

post-equipments-create
======================

Source
------

- Repository: ``jef-systems/jef-caferimo-backend``
- Module: ``caferimo``
- Documentation Scope: ``async``
- Lambda: ``jef-caferimo-post-3``

Endpoint
--------

- API Name: ``jef-caferimo``
- Action Name: ``post``
- Method: ``POST``
- Scope Label: ``Async``
- Resource Path: ``/post-equipments-create``
- Complete Endpoint: ``https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/post-equipments-create``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-post-3``
- curl payload mode: ``json_body``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-caferimo-post-3
   API Name: jef-caferimo
   Action: post
   Method: POST
   Resource Path: /post-equipments-create
   
   Payload:
   - entity_number: string-4-digits-nonzerostart
   - asset_number: string
   - asset_name: string
   - category: string
   - status: string-enum-active-maintenance-retired
   - notes: string-optional
   
   Response:
   - exists: boolean
   - message: string
   - item: {"pk":"string-{entity_number}#{asset_number}","gsi_1_pk":"string-{entity_number}#{category}","gsi_1_sk":"string-asset_name","entity_number":"string-4-digits-nonzerostart","asset_number":"string","asset_name":"string","category":"string","status":"string-enum-active-maintenance-retired","notes":"string-optional"}

Request Payload
---------------

.. code-block:: json

   {
     "entity_number": "string-4-digits-nonzerostart",
     "asset_number": "string",
     "asset_name": "string",
     "category": "string",
     "status": "string-enum-active-maintenance-retired",
     "notes": "string-optional"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"pk\":\"string-{entity_number}#{asset_number}\",\"gsi_1_pk\":\"string-{entity_number}#{category}\",\"gsi_1_sk\":\"string-asset_name\",\"entity_number\":\"string-4-digits-nonzerostart\",\"asset_number\":\"string\",\"asset_name\":\"string\",\"category\":\"string\",\"status\":\"string-enum-active-maintenance-retired\",\"notes\":\"string-optional\"}"
   }

CMD curl
--------

.. code-block:: text

   curl -X POST "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/post-equipments-create" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"string-4-digits-nonzerostart\", \"asset_number\": \"string\", \"asset_name\": \"string\", \"category\": \"string\", \"status\": \"string-enum-active-maintenance-retired\", \"notes\": \"string-optional\"}"

PowerShell curl
---------------

.. code-block:: text

   curl.exe -X POST "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/post-equipments-create" -H "Content-Type: application/json" --data-raw '{"entity_number": "string-4-digits-nonzerostart", "asset_number": "string", "asset_name": "string", "category": "string", "status": "string-enum-active-maintenance-retired", "notes": "string-optional"}'