Jump to

• Request
• Response

Get one supply with late maturity.

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ViewLateMaturityRecommendations/{ViewLateMaturityRecommendationsUniqID}

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=
• ViewLateMaturityRecommendationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, RecommendationType and RecommendationsId ---for the View Late Maturity Supplies resource and used to uniquely identify an instance of View Late Maturity Supplies. The client should not generate the hash key value. Instead, the client should query on the View Late Maturity Supplies collection resource with a filter on the primary key values in order to navigate to a specific instance of View Late Maturity Supplies.
  
  For example: ViewLateMaturityRecommendations?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-ViewLateMaturityRecommendations-item-response

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 4000

  Currency code associated with the organization of the supply with late maturity.
• 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.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the item for the supply with late maturity.
• FirmPlannedType: integer
  Read Only: true

  Indicates whether a supply order is firm. Valid values are 1 and 2. This attribute doesn't have a default value.
• FirmStatus: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether a supply order is firm. Valid values are firm or not firm. This attribute doesn't have a default value.
• InventoryItemId: integer
  Read Only: true

  Unique identifier of an inventory item.
• Item: string
  Read Only: true

  Maximum Length: 300

  Name of the item for the supply with late maturity.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the supply with late maturity was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the supply with late maturity.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Lot number associated with the supply with late maturity.
• MaturityDate: string (date)
  Read Only: true

  The date when the supply is matured.
• Notes: integer
  Read Only: true

  Notes regarding when the supply with late maturity was created or updated.
• OrderNumber: string
  Maximum Length: 240

  Order number of the supply in the transfer order.
• OrderQuantity: number
  Order quantity of the supply order.
• OrderType: integer
  Order type of the supply order.
• OrderTypeText: string
  Read Only: true

  Maximum Length: 4000

  Name of the supply order types, such as on hand or in transit.
• OrderValue: number
  Read Only: true

  Value of the supply order.
• Organization: string
  Read Only: true

  Maximum Length: 49

  Name of the organization in the supply with late maturity.
• OrganizationId: integer
  Value that uniquely identifies the organization of the supply order.
• PlanId: integer
  Value that uniquely identifies the plan that has the supplies with late maturity.
• RecommendationsId: integer
  Unique identifier of the recommendation type.
• RecommendationType: integer
  Type of recommendation made, such as view supplies with late maturity.
• SourceOrganization: string
  Read Only: true

  Maximum Length: 4000

  Source organization for the supply order.
• SourceOrganizationId: integer
  Read Only: true

  Unique identifier for the source organization.
• SuggestedDueDate: string (date)
  Read Only: true

  Date when a supply is expected to be completed.
• TransactionId: integer
  Read Only: true

  Value that uniquely identifies the supply transaction. This value is internally generated by the application.
• UOM: string
  Read Only: true

  Maximum Length: 4000

  Name of the unit of measure associated with the order quantity.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Currency code associated with the organization of the supply with late maturity.",
            "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
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item for the supply with late maturity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmPlannedType":{
            "type":"integer",
            "description":"Indicates whether a supply order is firm. Valid values are 1 and 2. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether a supply order is firm. Valid values are firm or not firm. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Unique identifier of an inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item for the supply with late maturity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the supply with late maturity 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 supply with late maturity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Lot":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number associated with the supply with late maturity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaturityDate":{
            "type":"string",
            "description":"The date when the supply is matured.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "type":"integer",
            "description":"Notes regarding when the supply with late maturity was created or updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Order number of the supply in the transfer order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderQuantity":{
            "type":"number",
            "description":"Order quantity of the supply order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderType":{
            "type":"integer",
            "description":"Order type of the supply order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderTypeText":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supply order types, such as on hand or in transit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderValue":{
            "type":"number",
            "description":"Value of the supply order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization in the supply with late maturity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the supply order.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan that has the supplies with late maturity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendationType":{
            "type":"integer",
            "description":"Type of recommendation made, such as view supplies with late maturity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendationsId":{
            "type":"integer",
            "description":"Unique identifier of the recommendation type.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "maxLength":4000,
            "type":"string",
            "description":"Source organization for the supply order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDueDate":{
            "type":"string",
            "description":"Date when a supply is expected to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the unit of measure associated with the order quantity.",
            "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