Jump to

• Request
• Response

Get one plan organization

get

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanOrganization/{TransactionId}

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=
• TransactionId(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=

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 : planOptions-PlanOrganization-item-response

Type: object

Show Source

• BillOfResources: string
  Maximum Length: 10

  Label for a list for the Create Bills of Resources scheduled process. The planner can choose for the resource structure to be within a single organization or across multiple organizations.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the plan organization.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan organization was originally created.
• Description: string
  Read Only: true

  Maximum Length: 255

  Description for the source system organization.
• ForecastSpreadingCalendar: string
  Maximum Length: 22

  Calendar used for forecast spreading an aggregate demand plan forecast across multiple time buckets.
• FrcstSpreadingCalName: string
  Read Only: true

  Maximum Length: 255

  Name of the calendar used for forecast spreading.
• IncludeProductionSchedule: number
  Indicates whether production schedules are considered in the planning process.
• IncludeSalesorder: number
  Specifies whether sales orders are considered to net from forecasts.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetOnHand: number
  Net on-hand quantity of an item.
• NetPurchasing: number
  Net purchased quantity of an item.
• NetReservations: number
  Net reserved quantity of an item.
• NetTransfers: number
  Final net on the transfer quantity of an item.
• NetWIP: number
  Net work in process quantity of an item.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan version number.
• OrganizationCode: string
  Maximum Length: 49

  Short code for the organization.
• OrganizationId: integer (int64)
  Unique value that identifies an organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 255

  Name of the organization.
• ParentOrgId: integer
  Identifies the organization selected from a list of values to be the parent for a child organization. Parent and child organizations are modeled for pooling child organization supplies into a parent organization for netting demands. Parent and child modeling for organizations is set up using the Manage Planning Source Systems task.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanSafetyStock: number
  Plan option that triggers supply plan to calculate safety stock.
• ProductionScheduleId: integer (int64)
  Value that uniquely identifies the production schedule.
• SimulationSet: string
  Maximum Length: 10

  Name of a simulation set. A simulation set consists of adjustments to plan inputs that can be applied to a plan to model different business scenarios, such as increasing available resource capacity.
• SubInventory: array Subinventories
  Title: Subinventories

  The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.
• TransactionId: integer (int64)
  Unique transaction identifier.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeSalesorder":{
            "type":"number",
            "description":"Specifies whether sales orders are considered to net from forecasts.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan organization was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the source system organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastSpreadingCalendar":{
            "maxLength":22,
            "type":"string",
            "description":"Calendar used for forecast spreading an aggregate demand plan forecast across multiple time buckets.",
            "nullable":true,
            "x-queryable":true
        },
        "NetOnHand":{
            "type":"number",
            "description":"Net on-hand quantity of an item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique value that identifies an organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FrcstSpreadingCalName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the calendar used for forecast spreading.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":49,
            "type":"string",
            "description":"Short code for the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NetReservations":{
            "type":"number",
            "description":"Net reserved quantity of an item.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanSafetyStock":{
            "type":"number",
            "description":"Plan option that triggers supply plan to calculate safety stock.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubInventory":{
            "title":"Subinventories",
            "type":"array",
            "description":"The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.",
            "items":{
                "$ref":"#/components/schemas/planOptions-PlanOrganization-SubInventory-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NetPurchasing":{
            "type":"number",
            "description":"Net purchased quantity of an item.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Unique transaction identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeProductionSchedule":{
            "type":"number",
            "description":"Indicates whether production schedules are considered in the planning process.",
            "nullable":true,
            "x-queryable":true
        },
        "BillOfResources":{
            "maxLength":10,
            "type":"string",
            "description":"Label for a list for the Create Bills of Resources scheduled process. The planner can choose for the resource structure to be within a single organization or across multiple organizations.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductionScheduleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationSet":{
            "maxLength":10,
            "type":"string",
            "description":"Name of a simulation set. A simulation set consists of adjustments to plan inputs that can be applied to a plan to model different business scenarios, such as increasing available resource capacity.",
            "nullable":true,
            "x-queryable":true
        },
        "NetTransfers":{
            "type":"number",
            "description":"Final net on the transfer quantity of an item.",
            "nullable":true,
            "x-queryable":true
        },
        "NetWIP":{
            "type":"number",
            "description":"Net work in process quantity of an item.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentOrgId":{
            "type":"integer",
            "description":"Identifies the organization selected from a list of values to be the parent for a child organization. Parent and child organizations are modeled for pooling child organization supplies into a parent organization for netting demands. Parent and child modeling for organizations is set up using the Manage Planning Source Systems task.",
            "nullable":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 : Subinventories

Type: array

Title: Subinventories

The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.

Show Source

• Array of: object planOptions-PlanOrganization-SubInventory-item-response

{
    "title":"Subinventories",
    "type":"array",
    "description":"The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.",
    "items":{
        "$ref":"#/components/schemas/planOptions-PlanOrganization-SubInventory-item-response"
    }
}

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."
        }
    }
}

Nested Schema : planOptions-PlanOrganization-SubInventory-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  Name of the user who created the plan subinventory.
• CreationDate: string (date-time)
  Date when the plan subinventory was originally created.
• Description: string
  Maximum Length: 50

  Description associated with the subinventory.
• DisableDate: string (date)
  Date when the subinventory is no longer valid.
• IncludeNonNettable: number
  Indicates whether to include nonnettable subinventory.
• InventoryATPCode: number
  Inventory available to promise code.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NettingType: integer (int64)
  Identifies the subinventory netting code, which are Nettable inventory and Nonnettable inventory.
• OrganizationId: integer (int64)
  Organization with which the subinventory is associated.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• RefreshNumber: number
  Name of a column on the Collected Measure Data page. This column is populated by the collection program and stores the internal ID of the collection or import process.
• SubInventoryCode: string
  Maximum Length: 10

  Code of the subinventory.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan subinventory was originally created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "IncludeNonNettable":{
            "type":"number",
            "description":"Indicates whether to include nonnettable subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"Description associated with the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RefreshNumber":{
            "type":"number",
            "description":"Name of a column on the Collected Measure Data page. This column is populated by the collection program and stores the internal ID of the collection or import process.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization with which the subinventory is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NettingType":{
            "type":"integer",
            "description":"Identifies the subinventory netting code, which are Nettable inventory and Nonnettable inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubInventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code of the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the subinventory is no longer valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryATPCode":{
            "type":"number",
            "description":"Inventory available to promise code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":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"
    }
}

Links

SubInventory

Operation: /fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanOrganization/{TransactionId}/child/SubInventory

Parameters:

• PlanId: $request.path.PlanId
• TransactionId2: $request.path.TransactionId2

The subinventories of a user-selected organization specified in the plan options that are used in the supply planning process, which generates supplies for the subinventories, if needed.

Back to Top