AlphaAlpha Docs
API Reference

Waste

API calls concerning waste registration

Create a waste record

POST
/waste-management

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/waste-management" \  -H "Content-Type: application/json" \  -d '{    "dto": {      "productId": "string",      "quantity": 0.1,      "reason": "string",      "stockSiteId": "string"    }  }'
{
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deductRawMaterials": true,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "image": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "productId": "string",
  "quantity": 0.1,
  "reason": "string",
  "shiftId": "string",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find waste records by shift ID

GET
/waste-management/by-shift/{shiftId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

shiftId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/by-shift/string"
[
  {
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deductRawMaterials": true,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "image": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "productId": "string",
    "quantity": 0.1,
    "reason": "string",
    "shiftId": "string",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Waste

GET
/waste-management/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/waste-management/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/waste-management/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Waste

GET
/waste-management/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/dynamic-search"
{
  "content": [
    {
      "approvedBy": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deductRawMaterials": true,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "image": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "productId": "string",
      "quantity": 0.1,
      "reason": "string",
      "shiftId": "string",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Waste

POST
/waste-management/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/waste-management/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "approvedBy": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deductRawMaterials": true,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "image": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "productId": "string",
      "quantity": 0.1,
      "reason": "string",
      "shiftId": "string",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/waste-management/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/find?ids=string"
[
  {
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deductRawMaterials": true,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "image": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "productId": "string",
    "quantity": 0.1,
    "reason": "string",
    "shiftId": "string",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/waste-management/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/find-all"
[
  {
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deductRawMaterials": true,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "image": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "productId": "string",
    "quantity": 0.1,
    "reason": "string",
    "shiftId": "string",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find waste records by a list of IDs

GET
/waste-management/find-by-list-of-ids

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/find-by-list-of-ids?ids=string"
[
  {
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deductRawMaterials": true,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "image": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "productId": "string",
    "quantity": 0.1,
    "reason": "string",
    "shiftId": "string",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/waste-management/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/find-list"
[
  {
    "approvedBy": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deductRawMaterials": true,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "image": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "productId": "string",
    "quantity": 0.1,
    "reason": "string",
    "shiftId": "string",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/waste-management/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/find/string"
{
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deductRawMaterials": true,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "image": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "productId": "string",
  "quantity": 0.1,
  "reason": "string",
  "shiftId": "string",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/waste-management/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/waste-management/page"
{
  "content": [
    {
      "approvedBy": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deductRawMaterials": true,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "image": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "productId": "string",
      "quantity": 0.1,
      "reason": "string",
      "shiftId": "string",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update a waste record

PATCH
/waste-management/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/waste-management/string" \  -H "Content-Type: application/json" \  -d '{    "productId": "string",    "quantity": 0.1,    "reason": "string",    "stockSiteId": "string"  }'
{
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deductRawMaterials": true,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "image": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "productId": "string",
  "quantity": 0.1,
  "reason": "string",
  "shiftId": "string",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/waste-management/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/waste-management/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Approve a waste record

POST
/waste-management/{id}/approve

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/waste-management/string/approve"
{
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deductRawMaterials": true,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "image": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "productId": "string",
  "quantity": 0.1,
  "reason": "string",
  "shiftId": "string",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/waste-management/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/waste-management/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deductRawMaterials": true,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "image": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "productId": "string",
  "quantity": 0.1,
  "reason": "string",
  "shiftId": "string",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Unapprove a waste record

POST
/waste-management/{id}/unapprove

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/waste-management/string/unapprove"
{
  "approvedBy": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deductRawMaterials": true,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "image": {
    "blobId": "string",
    "height": 0,
    "thumbnailBlobId": "string",
    "width": 0
  },
  "productId": "string",
  "quantity": 0.1,
  "reason": "string",
  "shiftId": "string",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Version

Previous Page

Tenants / Members

Next Page