Jump to

• Request
• Response

Get details of all resource exceptions

get

/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/ResourceExceptions

Request

Path Parameters

• PlanId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the resource exception according to the value that identifies the resource exception.
    Finder Variables
    • ExceptionDetailId; integer; Value that uniquely identifies the resource exception detail associated with the resource exception.
    • PlanId; integer; Value that uniquely identifies the plan associated with the resource exception.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionTaken; integer; Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
  • AdditionalCapacityRequiredByConstraintDate; number; Additional capacity to be added to the resource availability by the resource constraint date in the resource exception.
  • AvailableCapacity; number; Available capacity of the resource in the resource exception.
  • EndConstraintDate; string; End constraint date of the resource requirement of the resource in the resource exception.
  • Exception; string; Name of an exception.
  • ExceptionDetailId; integer; Value that uniquely identifies the resource exception detail.
  • ExceptionId; integer; Number that uniquely identifies an exception.
  • ExceptionStoreId; integer; Value that uniquely identifies the stored resource exception.
  • LastUpdateDate; string; Date when the exception detail was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the exception detail.
  • Notes; integer; Contains information created or updated for an exception detail represented as notes.
  • Organization; string; Name of the organization of an item for which an exception was calculated by the plan.
  • OrganizationId; integer; Value that uniquely identifies the organization of an item in the exception
  • PlanId; integer; Value that uniquely identifies the plan in which exception is generated.
  • RequiredCapacity; number; Capacity required by the resource in the resource exception.
  • ResourceAvailability; number; Availability of the resource in the resource exception.
  • ResourceCode; string; Code of the resource in the resource exception.
  • ResourceId; integer; Value that uniquely identifies the resource in the resource exception.
  • ResourceLoadRatio; number; Load ratio of the resource in the resource exception.
  • ResourceRequiredByConstraintDate; number; Resource requirement of the resource by the resource constraint date in the resource exception.
  • StartConstraintDate; string; Constraint start date of the resource requirement of the resource in the resource exception.
  • WorkCenter; string; Code of the work center of the resource in the resource exception.
  • WorkCenterId; integer; Value that uniquely identifies the work center of the resource in the resource exception.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : demandAndSupplyPlans-ResourceExceptions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/demandAndSupplyPlans-ResourceExceptions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object demandAndSupplyPlans-ResourceExceptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/demandAndSupplyPlans-ResourceExceptions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : demandAndSupplyPlans-ResourceExceptions-item-response

Type: object

Show Source

• ActionTaken: integer (int64)
  Title: Action Taken

  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
• AdditionalCapacityRequiredByConstraintDate: number
  Title: Additional Capacity Required by Date of Supplier Capacity Constraint

  Read Only: true

  Additional capacity to be added to the resource availability by the resource constraint date in the resource exception.
• AvailableCapacity: number
  Title: Available Capacity

  Read Only: true

  Available capacity of the resource in the resource exception.
• EndConstraintDate: string (date)
  Title: Constraint End Date

  Read Only: true

  End constraint date of the resource requirement of the resource in the resource exception.
• Exception: string
  Title: Exception

  Read Only: true

  Maximum Length: 120

  Name of an exception.
• ExceptionDetailId: integer
  Read Only: true

  Value that uniquely identifies the resource exception detail.
• ExceptionId: integer
  Read Only: true

  Number that uniquely identifies an exception.
• ExceptionStoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the stored resource exception.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the exception detail was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the exception detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: integer (int64)
  Title: Notes

  Read Only: true

  Contains information created or updated for an exception detail represented as notes.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization of an item for which an exception was calculated by the plan.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the organization of an item in the exception
• PlanId: integer
  Read Only: true

  Value that uniquely identifies the plan in which exception is generated.
• RequiredCapacity: number
  Title: Required Capacity

  Read Only: true

  Capacity required by the resource in the resource exception.
• ResourceAvailability: number
  Title: Available Capacity

  Read Only: true

  Availability of the resource in the resource exception.
• ResourceCode: string
  Title: Resource

  Read Only: true

  Maximum Length: 4000

  Code of the resource in the resource exception.
• ResourceId: integer
  Read Only: true

  Value that uniquely identifies the resource in the resource exception.
• ResourceLoadRatio: number
  Title: Resource Load Ratio

  Read Only: true

  Load ratio of the resource in the resource exception.
• ResourceRequiredByConstraintDate: number
  Title: Resource Requirement by Resource Constraint Date

  Read Only: true

  Resource requirement of the resource by the resource constraint date in the resource exception.
• StartConstraintDate: string (date)
  Title: Start Constraint Date

  Read Only: true

  Constraint start date of the resource requirement of the resource in the resource exception.
• WorkCenter: string
  Title: Work Center

  Read Only: true

  Maximum Length: 4000

  Code of the work center of the resource in the resource exception.
• WorkCenterId: integer
  Read Only: true

  Value that uniquely identifies the work center of the resource in the resource exception.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Resource",
            "maxLength":"4000",
            "type":"string",
            "description":"Code of the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center of the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the organization of an item for which an exception was calculated by the plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalCapacityRequiredByConstraintDate":{
            "title":"Additional Capacity Required by Date of Supplier Capacity Constraint",
            "type":"number",
            "description":"Additional capacity to be added to the resource availability by the resource constraint date in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailableCapacity":{
            "title":"Available Capacity",
            "type":"number",
            "description":"Available capacity of the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan in which exception is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceLoadRatio":{
            "title":"Resource Load Ratio",
            "type":"number",
            "description":"Load ratio of the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of an item in the exception",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Number that uniquely identifies an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception",
            "maxLength":"120",
            "type":"string",
            "description":"Name of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartConstraintDate":{
            "title":"Start Constraint Date",
            "type":"string",
            "description":"Constraint start date of the resource requirement of the resource in the resource exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredCapacity":{
            "title":"Required Capacity",
            "type":"number",
            "description":"Capacity required by the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceRequiredByConstraintDate":{
            "title":"Resource Requirement by Resource Constraint Date",
            "type":"number",
            "description":"Resource requirement of the resource by the resource constraint date in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndConstraintDate":{
            "title":"Constraint End Date",
            "type":"string",
            "description":"End constraint date of the resource requirement of the resource in the resource exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAvailability":{
            "title":"Available Capacity",
            "type":"number",
            "description":"Availability of the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenter":{
            "title":"Work Center",
            "maxLength":"4000",
            "type":"string",
            "description":"Code of the work center of the resource in the resource exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionStoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stored resource exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionTaken":{
            "title":"Action Taken",
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "type":"integer",
            "description":"Contains information created or updated for an exception detail represented as notes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the exception detail was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top