Jump to

• Request
• Response

Resource availability

post

/fscmRestApi/msp/latest/globalOrderPromises/resourceAvailability

Resource availability

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CallingInstance: string
  Value that uniquely identifies the source application from which the order promising service request originated.
• CallingModule: string
  Value that identifies the module from which the order promising service request originated.
• EndDateTime: string (date-time)
  Date when the supply availability information stops being returned. This attribute represents the end date of the supply availability request date range.
• QueryIdentifier: string
  Value that uniquely identifies the order promising web service query.
• RequestCreationDateTime: string (date-time)
  Date and time when the supply availability request was created.
• RequestTimeZone: string
  Time zone from which the supply availability input originated.
• ResourceInfoList: array ResourceInfoList
  Values that represent the input attributes related to resource,departnment and organization for the ResourceAvailabilityInput request.
• StartDateTime: string (date-time)
  Date when the supply availability information starts to be returned. This attribute represents the start date of the supply availability request date range.

{
    "type":"object",
    "properties":{
        "CallingModule":{
            "type":"string",
            "description":"Value that identifies the module from which the order promising service request originated."
        },
        "CallingInstance":{
            "type":"string",
            "description":"Value that uniquely identifies the source application from which the order promising service request originated."
        },
        "RequestCreationDateTime":{
            "type":"string",
            "description":"Date and time when the supply availability request was created.",
            "format":"date-time"
        },
        "RequestTimeZone":{
            "type":"string",
            "description":"Time zone from which the supply availability input originated."
        },
        "QueryIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the order promising web service query."
        },
        "StartDateTime":{
            "type":"string",
            "description":"Date when the supply availability information starts to be returned. This attribute represents the start date of the supply availability request date range.",
            "format":"date-time"
        },
        "EndDateTime":{
            "type":"string",
            "description":"Date when the supply availability information stops being returned. This attribute represents the end date of the supply availability request date range.",
            "format":"date-time"
        },
        "ResourceInfoList":{
            "type":"array",
            "description":"Values that represent the input attributes related to  resource,departnment and organization for the ResourceAvailabilityInput request.",
            "items":{
                "$ref":"#/components/schemas/ResourceInfo"
            }
        }
    }
}

Nested Schema : ResourceInfoList

Type: array

Values that represent the input attributes related to resource,departnment and organization for the ResourceAvailabilityInput request.

Show Source

• Array of: object ResourceInfo

{
    "type":"array",
    "description":"Values that represent the input attributes related to  resource,departnment and organization for the ResourceAvailabilityInput request.",
    "items":{
        "$ref":"#/components/schemas/ResourceInfo"
    }
}

Nested Schema : ResourceInfo

Type: object

Show Source

• DepartmentIdentifier: string
  Value that uniquely identifies the department.
• OrgInfo: object OrgInfo
• ResourceIdentifier: string
  Value that uniquely identifies the resource.

{
    "type":"object",
    "properties":{
        "ResourceIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the resource."
        },
        "DepartmentIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the department."
        },
        "OrgInfo":{
            "$ref":"#/components/schemas/OrgInfo"
        }
    }
}

Nested Schema : OrgInfo

Type: object

Show Source

• InstanceNumber: string
  Number that identifies the source application from which the order promising service request originated.
• OrgIdentifier: string
  Value that uniquely identifies the organization associated with the item.

{
    "type":"object",
    "properties":{
        "InstanceNumber":{
            "type":"string",
            "description":"Number that identifies the source application from which the order promising service request originated."
        },
        "OrgIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the organization associated with the item."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Request is processed and the results include the resource,depatrtment,organization,effective date,supply qauntity,consumed qunatity and cumulative qunatity.

Body ()

Root Schema : ResourceAvailabilityOutput

Type: object

Show Source

• ErrorCode: string
  Abbreviation that identifies the error, if any. Its value is NULL if request is fulfilled or It can be 26 or OP_RUNTIME_ERROR.
• ErrorMessage: string
  Text of the error message, if any, for the error code.
• PromiseDateTime: string (date-time)
  Date and time when the promise is generated by the Oracle Global Order Promising Cloud.
• PromisingInstance: string
  Value that uniquely identifies the source application in which order promising is performed.
• PromisingSystem: string
  Value that identifies the Oracle Global Order Promising Cloud application that performed the supply availability.
• QueryIdentifier: string
  Value that uniquely identifies the order promising web service query.
• ResourceAvailabilityResultList: array ResourceAvailabilityResultList
  Values that represent the attributes of resource availability details for the resource availability service request.

{
    "type":"object",
    "properties":{
        "PromisingSystem":{
            "type":"string",
            "description":"Value that identifies the Oracle Global Order Promising Cloud application that performed the supply availability."
        },
        "PromisingInstance":{
            "type":"string",
            "description":"Value that uniquely identifies the source application in which order promising is performed."
        },
        "PromiseDateTime":{
            "type":"string",
            "description":"Date and time when the promise is generated by the Oracle Global Order Promising Cloud.",
            "format":"date-time"
        },
        "QueryIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the order promising web service query."
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the error, if any. Its value is NULL if request is fulfilled or It can be 26 or OP_RUNTIME_ERROR."
        },
        "ErrorMessage":{
            "type":"string",
            "description":"Text of the error message, if any, for the error code."
        },
        "ResourceAvailabilityResultList":{
            "type":"array",
            "description":"Values that represent the attributes of resource availability details for the resource availability service request.",
            "items":{
                "$ref":"#/components/schemas/ResourceAvailabilityResult"
            }
        }
    }
}

Nested Schema : ResourceAvailabilityResultList

Type: array

Values that represent the attributes of resource availability details for the resource availability service request.

Show Source

• Array of: object ResourceAvailabilityResult

{
    "type":"array",
    "description":"Values that represent the attributes of resource availability details for the resource availability service request.",
    "items":{
        "$ref":"#/components/schemas/ResourceAvailabilityResult"
    }
}

Nested Schema : ResourceAvailabilityResult

Type: object

Show Source

• DailyAvailabilitiesList: array DailyAvailabilitiesList
  Values that indicate the quantity of resource available on a particular day.
• DepartmentIdentifier: string
  Value that uniquely identifies the department.
• OrgInfoList: array OrgInfoList
  Values that determine the resource availability.
• ResourceIdentifier: string
  Value that uniquely identifies the resource.

{
    "type":"object",
    "properties":{
        "ResourceIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the resource."
        },
        "OrgInfoList":{
            "type":"array",
            "description":"Values that determine the resource availability.",
            "items":{
                "$ref":"#/components/schemas/OrgInfo"
            }
        },
        "DepartmentIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the department."
        },
        "DailyAvailabilitiesList":{
            "type":"array",
            "description":"Values that indicate the quantity of resource available on a particular day.",
            "items":{
                "$ref":"#/components/schemas/DailyAvailability"
            }
        }
    }
}

Nested Schema : DailyAvailabilitiesList

Type: array

Values that indicate the quantity of resource available on a particular day.

Show Source

• Array of: object DailyAvailability

{
    "type":"array",
    "description":"Values that indicate the quantity of resource available on a particular day.",
    "items":{
        "$ref":"#/components/schemas/DailyAvailability"
    }
}

Nested Schema : OrgInfoList

Type: array

Values that determine the resource availability.

Show Source

• Array of: object OrgInfo

{
    "type":"array",
    "description":"Values that determine the resource availability.",
    "items":{
        "$ref":"#/components/schemas/OrgInfo"
    }
}

Nested Schema : DailyAvailability

Type: object

Show Source

• ConsumedQuantity: number (double)
  Quantity of the available to promise inventory consumed by both the independent and dependant demands.
• CummulativeQuantity: number (double)
  Quantity available to promise quantity that is accumulated from horizon start date onwards, adjusted after considering the net quantity.
• EffectiveDateTime: string (date-time)
  Date and Time when the daily availability information is returned.
• NetQuantity: number (double)
  Quantity Difference between supply quantity and consumed quantity.
• SupplyQuantity: number (double)
  Quantity of available supply for the specified set of input parameters.

{
    "type":"object",
    "properties":{
        "EffectiveDateTime":{
            "type":"string",
            "description":"Date and Time when the daily availability information is returned.",
            "format":"date-time"
        },
        "SupplyQuantity":{
            "type":"number",
            "description":"Quantity of available supply for the specified set of input parameters.",
            "format":"double"
        },
        "ConsumedQuantity":{
            "type":"number",
            "description":"Quantity of the available to promise inventory consumed by both the independent and dependant demands.",
            "format":"double"
        },
        "NetQuantity":{
            "type":"number",
            "description":"Quantity Difference between supply quantity and consumed quantity.",
            "format":"double"
        },
        "CummulativeQuantity":{
            "type":"number",
            "description":"Quantity available to promise quantity that is accumulated from horizon start date onwards, adjusted after considering the net quantity.",
            "format":"double"
        }
    }
}

Nested Schema : OrgInfo

Type: object

Show Source

• InstanceNumber: string
  Number that identifies the source application from which the order promising service request originated.
• OrgIdentifier: string
  Value that uniquely identifies the organization associated with the item.

{
    "type":"object",
    "properties":{
        "InstanceNumber":{
            "type":"string",
            "description":"Number that identifies the source application from which the order promising service request originated."
        },
        "OrgIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the organization associated with the item."
        }
    }
}

Back to Top