Facility

Facility Registry

This module facilitates the maintenance of a Facility registry.

Create/Add a new facility

Create a new facility

POST/facility/v1/_create

Body

application/json

Capture details of Facility.

Facility*any

Response

202400

Facility request has been accepted.

Body

*/*

Facilityany

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Create/Add new facilities in bulk

Create a new facilities in bulk

POST/facility/v1/bulk/_create

Body

application/json

Capture details of Facility.

Facilitiesarray of any

Response

202400

Facility request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Update the details of a existing facility

Update the details of a existing facility

POST/facility/v1/_update

Body

application/json

Details for existing facility.

Facility*Facility (object)

Response

202400

Facility request accepted.

Body

*/*

FacilityFacility (object)

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Facility": {}
    }),
});
const data = await response.json();

Response

202

{
  "Facility": {
    "isPermanent": true,
    "name": "Facility XYZ",
    "usage": "STORAGE_WAREHOUSE",
    "storageCapacity": 0
  }
}

Update the details of existing facilities in bulk

Update the details of a existing facilities in bulk

POST/facility/v1/bulk/_update

Body

application/json

Details for existing facility.

Facilitiesarray of Facility (object)

Response

202400

Facility request accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Soft delete details of an existing facility

Soft delete details of an existing facility

POST/facility/v1/_delete

Body

application/json

Details for existing facility.

Facility*Facility (object)

Response

202400

Facility request accepted.

Body

*/*

FacilityFacility (object)

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Facility": {}
    }),
});
const data = await response.json();

Response

202

{
  "Facility": {
    "isPermanent": true,
    "name": "Facility XYZ",
    "usage": "STORAGE_WAREHOUSE",
    "storageCapacity": 0
  }
}

Soft delete details of existing facilities in bulk

Soft delete details of an existing facilities in bulk

POST/facility/v1/bulk/_delete

Body

application/json

Details for existing facility.

any

Response

202400

Facility request accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

202

{}

Search existing facility

Search existing facility

POST/facility/v1/_search

Query parameters

Body

application/json

Details for existing facility.

Facility*FacilitySearch (object)

Response

200400

Facilities.

Body

*/*

Facilitiesarray of Facility (object)

Request

JavaScriptCurlPython

const response = await fetch('/facility/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Facility": {}
    }),
});
const data = await response.json();

Response

200

{
  "Facilities": [
    {
      "isPermanent": true,
      "name": "Facility XYZ",
      "usage": "STORAGE_WAREHOUSE",
      "storageCapacity": 0
    }
  ]
}