Jump to

• Request
• Response

Get one resource availability recommendation.

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ResourceAvailabilityRecommendations/{ResourceAvailabilityRecommendationsUniqID}

Request

Path Parameters

• PlanId(required): integer(int64)
  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=
• ResourceAvailabilityRecommendationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, RecommendationType and RecommendationsId ---for the Add Resource Availability Recommendations resource and used to uniquely identify an instance of Add Resource Availability Recommendations. The client should not generate the hash key value. Instead, the client should query on the Add Resource Availability Recommendations collection resource with a filter on the primary key values in order to navigate to a specific instance of Add Resource Availability Recommendations.
  
  For example: ResourceAvailabilityRecommendations?q=PlanId=<value1>;RecommendationType=<value2>;RecommendationsId=<value3>

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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 : supplyPlans-ResourceAvailabilityRecommendations-item-response

Type: object

Show Source

• AdditionalCapacityByDate: number
  Read Only: true

  Additional capacity required because of the resource constraint date.
• AvailableCapacity: number
  Read Only: true

  Available resource capacity.
• CapacityOverload: number
  Read Only: true

  Resource capacity overload.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 400

  Value that uniquely identifies the currency.
• DataSecurityEditAllowed: string
  Read Only: true

  Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
• DepartmentId: integer
  Unique identifier for the work center of the resource.
• EndDate: string (date)
  Read Only: true

  End date of the resource availability associated with the demand that's at risk.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the resource availability was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the resource availability.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Organization: string
  Read Only: true

  Maximum Length: 49

  Name of the organization in which the resource availability needs to be added.
• OrganizationId: integer
  Value that uniquely identifies the organization.
• PlanId: integer
  Value that uniquely identifies the plan in which add resource availability recommendations are generated.
• RecommendationsId: integer
  Unique identifier of the recommendation type.
• RecommendationType: integer
  Type of recommendation made, such as add resource availability.
• RequiredCapacity: number
  Read Only: true

  Required resource capacity to satisfy the demand that's at risk.
• ResourceCode: string
  Read Only: true

  Maximum Length: 4000

  Resource code for which the add resource availability recommendation is made.
• ResourceConstraintDate: string (date)
  Read Only: true

  Capacity constraint date of the resource associated with the demand that's at risk.
• ResourceCost: number
  Read Only: true

  Cost associated with using the resource.
• ResourceId: integer
  Unique identifier of the resource.
• StartDate: string (date)
  Read Only: true

  Start date of the resource availability associated with the demand that's at risk.
• Status: integer
  Status value of the expedite make order recommendation. Valid values are 1 - Accepted, 2 - In review, and 3 - Pending. The default value is 3 - Pending.
• StatusText: string
  Read Only: true

  Maximum Length: 4000

  Status of the expedite buy order recommendation. Valid values are Pending, In review, and Accepted. The default value is Pending.
• WorkCenter: string
  Read Only: true

  Maximum Length: 4000

  Work center of the resource.

{
    "type":"object",
    "properties":{
        "AdditionalCapacityByDate":{
            "type":"number",
            "description":"Additional capacity required because of the resource constraint date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailableCapacity":{
            "type":"number",
            "description":"Available resource capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CapacityOverload":{
            "type":"number",
            "description":"Resource capacity overload.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":400,
            "type":"string",
            "description":"Value that uniquely identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSecurityEditAllowed":{
            "type":"string",
            "description":"Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the work center of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the resource availability associated with the demand that's at risk.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the resource availability was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the resource availability.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization in which the resource availability needs to be added.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan in which add resource availability recommendations are generated.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendationType":{
            "type":"integer",
            "description":"Type of recommendation made, such as add resource availability.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendationsId":{
            "type":"integer",
            "description":"Unique identifier of the recommendation type.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredCapacity":{
            "type":"number",
            "description":"Required resource capacity to satisfy the demand that's at risk.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Resource code for which the add resource availability recommendation is made.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceConstraintDate":{
            "type":"string",
            "description":"Capacity constraint date of the resource associated with the demand that's at risk.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCost":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Unique identifier of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the resource availability associated with the demand that's at risk.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status value of the expedite make order recommendation. Valid values are 1 - Accepted, 2 - In review, and 3 - Pending. The default value is 3 - Pending.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":4000,
            "type":"string",
            "description":"Status of the expedite buy order recommendation. Valid values are Pending, In review, and Accepted. The default value is Pending.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenter":{
            "maxLength":4000,
            "type":"string",
            "description":"Work center of the resource.",
            "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"
            }
        }
    }
}

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