PATCH /one-patch-session-job

Summary

  • Source repository: jef-systems/jef-one-backend

  • Source SHA: e96c5a3e498688e508b48a6c244ebbcb28dec45f

  • Source run id: 25680569267

  • Module: One

  • Lambda function: jef-one-patch-session-job

  • HTTP method: PATCH

  • Invocation mode: async

  • Package mode: with-packages

  • API category: One Complex With Package Async PATCH APIs

  • API path: /one-patch-session-job

  • Endpoint URL: https://1agiiayfri.execute-api.ap-southeast-1.amazonaws.com/prod/one-patch-session-job

  • Documentation scope: lambda-complex-with-packages

Async Confirmation Rule

This write API is documented as an async accepted request, not final write success. Use the corresponding GET API to confirm the final state.

Description

Accepts an asynchronous job to patch a jef-one session. Use GET to confirm final state.

Payload Example

{
  "session_id": "session-00001",
  "status": "active",
  "app_type": "mobile",
  "app_number": "001"
}

Payload Schema

{
  "session_id": "string",
  "status": "string",
  "app_type": "string",
  "app_number": "string"
}

Response Schema

{
  "is_accepted": "boolean",
  "message": "string",
  "operation": "string",
  "job_id": "string",
  "job_status": "string",
  "target_table": "string",
  "target_pk": "string",
  "confirmation": "string",
  "allowed_method": "string",
  "error_type": "string",
  "error_code": "string",
  "errors": "array",
  "error": "string"
}

Request Payload

{
  "session_id": "session-00001",
  "status": "active",
  "app_type": "mobile",
  "app_number": "001"
}

CMD curl

curl -X PATCH "https://1agiiayfri.execute-api.ap-southeast-1.amazonaws.com/prod/one-patch-session-job" -H "Content-Type: application/json" -d '{"session_id": "session-00001", "status": "active", "app_type": "mobile", "app_number": "001"}'

PowerShell curl

curl.exe -X PATCH "https://1agiiayfri.execute-api.ap-southeast-1.amazonaws.com/prod/one-patch-session-job" -H "Content-Type: application/json" -d "{\"session_id\": \"session-00001\", \"status\": \"active\", \"app_type\": \"mobile\", \"app_number\": \"001\"}"