MachineApi Resource

GET /api/v1/machine

Eine Liste aller verfügbaren Maschinen

Request Parameters
name type description constraints
filter_planningview query mit TRUE nur jene Maschinen liefern, die sich in einer Maschinengruppe befinden, die in der Planungsanzeige dargestellt werden soll boolean
filter_productiongroupid query int
filter_staffid query optional die Personal-Id jener Person, die eine laufende Maschine zuletzt gestartet hat int
filter_withHidden query boolean
limit query int
startIndex query int
userid query  
Response Body
media type data type description
application/json MachineEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/machine
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "inventoryNumber" : "...",
    "description" : "...",
    "identificationNumber" : "...",
    "machineGroupId" : 12345,
    "machineGroupDescription" : "...",
    "personalIdStarter" : 12345,
    "starttime" : 12345,
    "productionWorkplanId" : 12345,
    "machineGroupShortDescription" : "...",
    "machineGroupISort" : 12345,
    "id" : 12345
  }, {
    "inventoryNumber" : "...",
    "description" : "...",
    "identificationNumber" : "...",
    "machineGroupId" : 12345,
    "machineGroupDescription" : "...",
    "personalIdStarter" : 12345,
    "starttime" : 12345,
    "productionWorkplanId" : 12345,
    "machineGroupShortDescription" : "...",
    "machineGroupISort" : 12345,
    "id" : 12345
  } ]
}

GET /api/v1/machine/groups

Eine Liste aller Maschinengruppen

Request Parameters
name type description constraints
filter_planningview query mit TRUE nur jene Maschinen liefern, die sich in einer Maschinengruppe befinden, die in der Planungsanzeige dargestellt werden soll boolean
filter_productiongroupid query int
limit query int
startIndex query int
userid query  
Response Body
media type data type description
application/json MachineGroupEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/machine/groups
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "description" : "...",
    "showPlanningView" : true,
    "productionGroupDescription" : "...",
    "id" : 12345
  }, {
    "description" : "...",
    "showPlanningView" : true,
    "productionGroupDescription" : "...",
    "id" : 12345
  } ]
}

GET /api/v1/machine/planningview

Request Parameters
name type description constraints
dateMs query long
days query int
filter_productiongroupid query int
filter_startdate query boolean
filter_withHidden query boolean
limit query int
startIndex query int
userid query  
with_description query boolean
Response Body
media type data type description
application/json PlanningView (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/machine/planningview
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "machineList" : {
    "entries" : [ {
      "inventoryNumber" : "...",
      "description" : "...",
      "identificationNumber" : "...",
      "machineGroupId" : 12345,
      "machineGroupDescription" : "...",
      "personalIdStarter" : 12345,
      "starttime" : 12345,
      "productionWorkplanId" : 12345,
      "machineGroupShortDescription" : "...",
      "machineGroupISort" : 12345,
      "id" : 12345
    }, {
      "inventoryNumber" : "...",
      "description" : "...",
      "identificationNumber" : "...",
      "machineGroupId" : 12345,
      "machineGroupDescription" : "...",
      "personalIdStarter" : 12345,
      "starttime" : 12345,
      "productionWorkplanId" : 12345,
      "machineGroupShortDescription" : "...",
      "machineGroupISort" : 12345,
      "id" : 12345
    } ]
  },
  "openWorkList" : {
    "entries" : [ {
      "productionCnr" : "...",
      "productionProjectNr" : "...",
      "partlistCnr" : "...",
      "partlistDescription" : "...",
      "workNumber" : 12345,
      "workItemCnr" : "...",
      "workItemDescription" : "...",
      "workItemShortDescription" : "...",
      "workItemStartDate" : 12345,
      "workItemStartCalendarWeek" : 12345,
      "workItemStartCalendarYear" : 12345,
      "machineOffsetMs" : 12345,
      "duration" : 12345.0,
      "machineCnr" : "...",
      "machineDescription" : "...",
      "materialCnr" : "...",
      "materialDescription" : "...",
      "hasWorktime" : true,
      "customerShortDescription" : "...",
      "abc" : "...",
      "machineId" : 12345,
      "orderId" : 12345,
      "orderCnr" : "...",
      "overdue" : true,
      "orderFinalDateMs" : 12345,
      "progressPercent" : 12345.0,
      "targetDuration" : 12345.0,
      "partlistItemCnr" : "...",
      "partlistItemDescription" : "...",
      "partlistItemShortDescription" : "...",
      "actualTime" : 12345.0,
      "starttimeMoveable" : true,
      "finishtimeMoveable" : true,
      "openQuantity" : 12345.0,
      "productionFinalDateMs" : 12345,
      "id" : 12345
    }, {
      "productionCnr" : "...",
      "productionProjectNr" : "...",
      "partlistCnr" : "...",
      "partlistDescription" : "...",
      "workNumber" : 12345,
      "workItemCnr" : "...",
      "workItemDescription" : "...",
      "workItemShortDescription" : "...",
      "workItemStartDate" : 12345,
      "workItemStartCalendarWeek" : 12345,
      "workItemStartCalendarYear" : 12345,
      "machineOffsetMs" : 12345,
      "duration" : 12345.0,
      "machineCnr" : "...",
      "machineDescription" : "...",
      "materialCnr" : "...",
      "materialDescription" : "...",
      "hasWorktime" : true,
      "customerShortDescription" : "...",
      "abc" : "...",
      "machineId" : 12345,
      "orderId" : 12345,
      "orderCnr" : "...",
      "overdue" : true,
      "orderFinalDateMs" : 12345,
      "progressPercent" : 12345.0,
      "targetDuration" : 12345.0,
      "partlistItemCnr" : "...",
      "partlistItemDescription" : "...",
      "partlistItemShortDescription" : "...",
      "actualTime" : 12345.0,
      "starttimeMoveable" : true,
      "finishtimeMoveable" : true,
      "openQuantity" : 12345.0,
      "productionFinalDateMs" : 12345,
      "id" : 12345
    } ]
  },
  "machineAvailabilityMap" : {
    "property1" : {
      "entries" : [ {
        "machineId" : 12345,
        "dayTypeId" : 12345,
        "availabilityHours" : 12345.0,
        "dayTypeDescription" : "...",
        "dateMs" : 12345
      }, {
        "machineId" : 12345,
        "dayTypeId" : 12345,
        "availabilityHours" : 12345.0,
        "dayTypeDescription" : "...",
        "dateMs" : 12345
      } ]
    },
    "property2" : {
      "entries" : [ {
        "machineId" : 12345,
        "dayTypeId" : 12345,
        "availabilityHours" : 12345.0,
        "dayTypeDescription" : "...",
        "dateMs" : 12345
      }, {
        "machineId" : 12345,
        "dayTypeId" : 12345,
        "availabilityHours" : 12345.0,
        "dayTypeDescription" : "...",
        "dateMs" : 12345
      } ]
    }
  },
  "machineGroupList" : {
    "entries" : [ {
      "description" : "...",
      "showPlanningView" : true,
      "productionGroupDescription" : "...",
      "id" : 12345
    }, {
      "description" : "...",
      "showPlanningView" : true,
      "productionGroupDescription" : "...",
      "id" : 12345
    } ]
  },
  "holidayList" : {
    "entries" : [ {
      "date" : 12345,
      "dayTypeId" : 12345,
      "dayTypeDescription" : "...",
      "description" : "...",
      "id" : 12345
    }, {
      "date" : 12345,
      "dayTypeId" : 12345,
      "dayTypeDescription" : "...",
      "description" : "...",
      "id" : 12345
    } ]
  },
  "plantHolidayList" : {
    "entries" : [ {
      "date" : 12345,
      "dayTypeId" : 12345,
      "dayTypeDescription" : "...",
      "description" : "...",
      "id" : 12345
    }, {
      "date" : 12345,
      "dayTypeId" : 12345,
      "dayTypeDescription" : "...",
      "description" : "...",
      "id" : 12345
    } ]
  },
  "viewOpenWorkDetail" : "PROJEKT_KBEZ",
  "judgeWorkUnitChange" : true,
  "dispatchingGridMinutes" : 12345,
  "dispatchingBufferMinutes" : 12345
}

GET /api/v1/machine/{machineid}/availability

Request Parameters
name type description constraints
machineid path int
dateMs query long
days query int
userid query  
with_description query boolean
Response Body
media type data type description
application/json MachineAvailabilityEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/machine/{machineid}/availability
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "machineId" : 12345,
    "dayTypeId" : 12345,
    "availabilityHours" : 12345.0,
    "dayTypeDescription" : "...",
    "dateMs" : 12345
  }, {
    "machineId" : 12345,
    "dayTypeId" : 12345,
    "availabilityHours" : 12345.0,
    "dayTypeDescription" : "...",
    "dateMs" : 12345
  } ]
}