layer-farm-batches-patch-one

Source

• Repository: jef-systems/jef-layer-farm-backend

• Source Run ID: 24916443201

• Source SHA: 04fc05c78cba84982ce19870a690a0b7b6a02d48

• Module: layer-farm

• Documentation Scope: async

• Lambda: jef-layer-farm-patch-1

Endpoint

• API Name: jef-layer-farm

• Action Name: patch

• Method: PATCH

• Scope Label: Async

• Resource Path: /layer-farm-batches-patch-one

• Complete Endpoint: https://vx9egxavaa.execute-api.ap-southeast-1.amazonaws.com/prod/layer-farm-batches-patch-one

• Lambda ARN: arn:aws:lambda:ap-southeast-1:246715082475:function:jef-layer-farm-patch-1

• curl payload mode: json_body

API Gateway Description

Function: jef-layer-farm-patch-1
API Name: jef-layer-farm
Action: patch
Method: PATCH
Resource Path: /layer-farm-batches-patch-one

Payload:
- entity_number: string-4-digits-nonzerostart
- batch_id: string-{batch-slug}
- batch: string-optional
- start_date: string-yyyy-mm-dd-optional
- end_date: string-yyyy-mm-dd-optional
- is_active: boolean-optional
- notes: string-optional
- is_deleted: boolean-optional

Response:
- exists: boolean
- message: string
- source: string when operation reaches DynamoDB
- item: object when found/created/updated
- key: object when not found or duplicate

Request Payload

{
  "entity_number": "string-4-digits-nonzerostart",
  "batch_id": "string-{batch-slug}",
  "batch": "string-optional",
  "start_date": "string-yyyy-mm-dd-optional",
  "end_date": "string-yyyy-mm-dd-optional",
  "is_active": "boolean-optional",
  "notes": "string-optional",
  "is_deleted": "boolean-optional"
}

Response

{
  "exists": "boolean",
  "message": "string",
  "source": "string when operation reaches DynamoDB",
  "item": "object when found/created/updated",
  "key": "object when not found or duplicate"
}

CMD curl

curl -X PATCH "https://vx9egxavaa.execute-api.ap-southeast-1.amazonaws.com/prod/layer-farm-batches-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"string-4-digits-nonzerostart\", \"batch_id\": \"string-{batch-slug}\", \"batch\": \"string-optional\", \"start_date\": \"string-yyyy-mm-dd-optional\", \"end_date\": \"string-yyyy-mm-dd-optional\", \"is_active\": \"boolean-optional\", \"notes\": \"string-optional\", \"is_deleted\": \"boolean-optional\"}"

PowerShell curl

curl.exe -X PATCH "https://vx9egxavaa.execute-api.ap-southeast-1.amazonaws.com/prod/layer-farm-batches-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_number": "string-4-digits-nonzerostart", "batch_id": "string-{batch-slug}", "batch": "string-optional", "start_date": "string-yyyy-mm-dd-optional", "end_date": "string-yyyy-mm-dd-optional", "is_active": "boolean-optional", "notes": "string-optional", "is_deleted": "boolean-optional"}'