delete-equipments-by-asset-number

Source

  • Repository: jef-systems/jef-caferimo-backend

  • Module: caferimo

  • Documentation Scope: async

  • Lambda: jef-caferimo-delete-3

Endpoint

  • API Name: jef-caferimo

  • Action Name: delete

  • Method: DELETE

  • Scope Label: Async

  • Resource Path: /delete-equipments-by-asset-number

  • Complete Endpoint: https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/delete-equipments-by-asset-number

  • Lambda ARN: arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-delete-3

  • curl payload mode: json_body

API Gateway Description

Function: jef-caferimo-delete-3
API Name: jef-caferimo
Action: delete
Method: DELETE
Resource Path: /delete-equipments-by-asset-number

Payload:
- entity_number: string-4-digits-nonzerostart
- asset_number: string

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"}
- deleted_pk: string

Request Payload

{
  "entity_number": "string-4-digits-nonzerostart",
  "asset_number": "string"
}

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\"}",
  "deleted_pk": "string"
}

CMD curl

curl -X DELETE "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/delete-equipments-by-asset-number" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"string-4-digits-nonzerostart\", \"asset_number\": \"string\"}"

PowerShell curl

curl.exe -X DELETE "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/delete-equipments-by-asset-number" -H "Content-Type: application/json" --data-raw '{"entity_number": "string-4-digits-nonzerostart", "asset_number": "string"}'