v1_MaterialShortageReports_GetImpact

POST

/api/v1/material-shortage-reports/impact

MaterialShortageReports

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://localhost:7219/connect/token

Scopes:

fabritec.integration-Tenant integration access

Body Params

application/json

Required

Examples

Responses

🟢200

application/json

Body

🟠400

🟠401

🟠403

🟠404

🟠409

🟠422

🟠429

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/material-shortage-reports/impact' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "projectIds": [
        0
    ],
    "phaseIds": [
        0
    ],
    "finalItemsPage": 1,
    "finalItemsPageSize": 1,
    "shortagesPage": 1,
    "shortagesPageSize": 1,
    "warningsPage": 1,
    "warningsPageSize": 1,
    "detailsPage": 1,
    "detailsPageSize": 1
}'

Response Example

200 - Example 1

{
    "generatedAtUtc": "2019-08-24T14:15:22.123Z",
    "weightUnit": "string",
    "isEstimated": true,
    "estimationMethodCode": "string",
    "isComplete": true,
    "appliedScope": {
        "requestedProjectIds": [
            0
        ],
        "requestedPhaseIds": [
            0
        ],
        "resolvedProjectIds": [
            0
        ],
        "resolvedPhaseIds": [
            0
        ],
        "projectCount": 0,
        "phaseCount": 0,
        "projects": [
            {
                "id": 0,
                "jobNumber": "string",
                "name": "string"
            }
        ]
    },
    "summary": {
        "activeShortageItemCount": 0,
        "impactedFinalItemCount": 0,
        "estimatedBlockedFinalQuantity": 0,
        "estimatedBlockedFinalWeight": 0,
        "unallocatedShortageQuantity": 0,
        "invalidWeightBlockedQuantity": 0
    },
    "finalItems": {
        "items": [
            {
                "projectId": 0,
                "jobNumber": "string",
                "projectName": "string",
                "phaseId": 0,
                "phaseCode": "string",
                "phaseName": "string",
                "finalItemId": 0,
                "finalItemMark": "string",
                "finalItemName": "string",
                "eligibleRemainingQuantity": 0,
                "estimatedBlockedQuantity": 0,
                "unitWeight": null,
                "estimatedBlockedWeight": null,
                "causes": {
                    "items": [
                        {
                            "shortageItemId": 0,
                            "shortageItemMark": "string",
                            "shortageItemName": "string",
                            "markedShortageQuantity": 0,
                            "requirementPerFinalUnit": 0,
                            "estimatedAllocatedShortageQuantity": 0,
                            "perShortageEstimatedBlockedFinalQuantity": 0,
                            "unallocatedQuantity": 0
                        }
                    ],
                    "page": 0,
                    "pageSize": 0,
                    "totalCount": 0
                }
            }
        ],
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    },
    "shortages": {
        "items": [
            {
                "shortageItemId": 0,
                "shortageItemMark": "string",
                "shortageItemName": "string",
                "markedShortageQuantity": 0,
                "estimatedAllocatedShortageQuantity": 0,
                "unallocatedQuantity": 0
            }
        ],
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    },
    "warnings": {
        "items": [
            {
                "code": "string",
                "severity": "string",
                "isEstimateIncomplete": true,
                "entityIds": {
                    "items": [
                        0
                    ],
                    "page": 0,
                    "pageSize": 0,
                    "totalCount": 0
                },
                "messageArguments": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ],
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    }
}

Modified at 2026-10-11 11:38:51

v1_MaterialShortageReports_PhaseOptions

v1_MaterialShortageReports_ExportExcel