Get all organizations
get
/fscmRestApi/resources/11.13.18.05/supplyNetworkOrganizations
Request
Query Parameters
-
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 organizations according to the primary key criteria.
Finder Variables- OrganizationId; integer; Value that uniquely identifies the organization.
- SourceInstanceId; number; Value that uniquely identifies the source system in which the demand originated.
- SourceOrganizationCode; string; Abbreviation that identifies the source organization from which an item is planned.
- PrimaryKey Finds organizations according to the primary key criteria.
-
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:- AbcAssignmentGroupId; integer; Value that uniquely identifies the ABC assignment group.
- AbcAssignmentGroupName; string; Name to the ABC assignment group.
- ApplicationVersion; number; Value that indicates the version number of the Oracle Application instance.
- CalendarCode; string; Abbreviation that identifies the supply planning calendar.
- CalendarName; string; Name of the delivery calendar associated with the supplier item.
- CollectNonnettableParSubinventories; string; Indicates whether item subinventories for PAR-enabled, nonnettable subinventories are collected. Valid values are Yes and No.
- CollectNonnettableParSubinventoriesCode; number; Value that indicates whether item subinventories for PAR-enabled, nonnettable subinventories are collected. Values include 1 for No and 2 for Yes.
- CollectedFlag; boolean; Collected
- CreatedBy; string; User who created the order.
- CreationDate; string; Date when the user created the order.
- CurrencyCode; string; Abbreviation of the currency code.
- CustomerForCrossReferenceIndicator; integer; Indicates whether interorganization transfers are included in sales and bookings history, using the customer and customer site values associated with an organization.
- CustomerId; integer; Value that uniquely identifies the customer assigned to the organization.
- CustomerName; string; Name of the customer assigned to the organization.
- CustomerSiteCode; string; Abbreviation of the customer site assigned to the organization.
- CustomerSiteId; integer; Value that uniquely identifies the customer site assigned to the organization.
- CutoffHour; number; Indicates the hour associated with the cutoff time for the current day, after which orders can't be shipped from the facility. The cutoff time can be defined for an organization, a carrier, or a combination of these attributes.
- CutoffMinute; number; Indicates the minute associated with the cutoff time for the current day, after which orders can't be shipped from the facility. The cutoff time can be defined for an organization, a carrier, or a combination of these attributes.
- CutoffTime; number; Indicates the time associated with the cutoff time for the current day, after which orders can't be shipped from the facility. The cutoff time can be defined for an organization, a carrier, or a combination of these attributes.
- DefaultLocationCode; string; Abbreviation of the default location for the organization.
- DefaultLocationDescription; string; Description of the default location for the organization.
- DefaultLocationName; string; Name of the default location for the organization
- DropShipValidationOrganization; string; Indicates whether the organization is used as the validation organization for drop ship orders. Values include Yes and No.
- DropShipValidationOrganizationCode; integer; Abbreviation indicating whether the organization is used as the validation organization for drop ship orders. Values include 1 for Yes and 2 for No.
- ExternalManufacturerSupplies; number; Indicates if the organization uses external manufacturer supplies in planning.
- FixedDateIndicator; integer; Value that indicates whether the organization uses the fixed date defined in the MSC_FIXED_DATE profile option under the Manage Planning Profile Options task.
- GlobalForecastValidationOrganizationCode; integer; Abbreviation indicating that the organization is referenced for item attributes and bills of material in forecasts that don't have an associated organization.
- GlobalForecastValidationOrganizationIndicator; number; Indicates whether the organization is referenced for item attributes and bills of material in forecasts that don't have an associated organization.
- InventoryOrganization; string; Name of the inventory organization.
- InventoryOrganizationCode; number; Abbreviation that identifies the inventory organization.
- LastUpdateDate; string; Date and time when the record was last updated.
- LastUpdatedBy; string; User who last updated the record.
- MasterOrganizationCode; string; Abbreviation that identifies the master organization for the organization.
- MasterOrganizationId; integer; Value that uniquely identifies the master organization for the organization.
- NotesCount; integer; Number of notes associated with the organization.
- ObjectVersionNumber; integer; Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationGroup; string; Name of the organization group for the organization.
- OrganizationId; integer; Value that uniquely identifies the organization.
- OrganizationName; string; Name of the to organization.
- PastDueForecastDays; number; Number of days of past-due forecasts to include in plans.
- PastDueSalesOrderDays; integer; Number of days before the plan start date to include as a past-due sales order.
- PastDueSupplyDays; integer; Number of days before the plan start date to include as past-due supply.
- PickPackLeadTime; number; Value that identifies the time needed to pick and pack an item. The pick and pack lead time can be specified for an organization, carrier, or a combination of the organization and the airline.
- PlanComponentsSupplyTypeBulk; number; Indicates whether planning uses components with a supply type of Bulk for the organization. Values include null, 1 for Yes, and 2 for No.
- PlanComponentsSupplyTypeSupplier; number; Indicates whether planning uses components with a supply type of Supplier for the organization. Values include null, 1 for Yes, and 2 for No.
- ProjectControlLevel; number; Indicates whether the project control level of an organization is set to Project or Project and Task.
- ProjectReference; string; Indicates whether the project reference is enabled. Valid values are Yes and No.
- ProjectReferenceEnabled; number; Indicates whether the project reference is enabled. Valid values are 1 for Yes and 2 for No. The default value is No.
- SourceCalendarCode; string; Abbreviation that identifies the source calendar.
- SourceInstanceId; number; Value that uniquely identifies the source system in which the demand originated.
- SourceOrganizationCode; string; Abbreviation that identifies the source organization from which an item is planned.
- SourceSystemCode; string; Value that identifies the source system of the organization.
- SourceSystemId; integer; Uniquely identifies the source system.
- SubinventoryPlanning; string; Indicates whether the organization is enabled for subinventory-level planning. Values include Yes and No.
- SubinventoryPlanningCode; number; Indicates whether the organization is enabled for subinventory-level planning. Values include 1 for Yes and 2 for No.
- SupplierId; integer; Value that uniquely identifies the supplier assigned to the organization.
- SupplierName; string; Name of the supplier assigned to the organization.
- SupplierSiteCode; string; Abbreviation for the supplier site assigned to the organization.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site assigned to the organization.
- TimeZoneCode; string; Abbreviation that identifies the time zone assigned to the organization.
- TimeZoneName; string; Name of the time zone assigned to the organization.
- TimeZoneShortName; string; Abbreviation of the time zone assigned to the organization.
- VolumeUnitOfMeasureCode; string; Abbreviation that identifies the unit of measure for volume.
- VolumeUnitOfMeasureName; string; Name of the unit of measure for volume.
-
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: 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 TopResponse
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.
Root Schema : supplyNetworkOrganizations
Type:
Show Source
object-
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : supplyNetworkOrganizations-item-response
Type:
Show Source
object-
AbcAssignmentGroupId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ABC assignment group. -
AbcAssignmentGroupName: string
Read Only:
trueMaximum Length:40Name to the ABC assignment group. -
AdditionalInformationDFF: array
AdditionalInformationDFF
-
ApplicationVersion: number
Read Only:
trueValue that indicates the version number of the Oracle Application instance. -
CalendarCode: string
Read Only:
trueMaximum Length:22Abbreviation that identifies the supply planning calendar. -
CalendarName: string
Read Only:
trueMaximum Length:240Name of the delivery calendar associated with the supplier item. -
CollectedFlag: boolean
Read Only:
trueCollected -
CollectNonnettableParSubinventories: string
Read Only:
trueMaximum Length:4000Indicates whether item subinventories for PAR-enabled, nonnettable subinventories are collected. Valid values are Yes and No. -
CollectNonnettableParSubinventoriesCode: number
Read Only:
trueValue that indicates whether item subinventories for PAR-enabled, nonnettable subinventories are collected. Values include 1 for No and 2 for Yes. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the order. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the order. -
CurrencyCode: string
Read Only:
trueMaximum Length:30Abbreviation of the currency code. -
CustomerForCrossReferenceIndicator: integer
(int32)
Read Only:
trueIndicates whether interorganization transfers are included in sales and bookings history, using the customer and customer site values associated with an organization. -
CustomerId: integer
(int64)
Read Only:
trueValue that uniquely identifies the customer assigned to the organization. -
CustomerName: string
Read Only:
trueMaximum Length:4000Name of the customer assigned to the organization. -
CustomerSiteCode: string
Read Only:
trueMaximum Length:4000Abbreviation of the customer site assigned to the organization. -
CustomerSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the customer site assigned to the organization. -
CutoffHour: number
Read Only:
trueIndicates the hour associated with the cutoff time for the current day, after which orders can't be shipped from the facility. The cutoff time can be defined for an organization, a carrier, or a combination of these attributes. -
CutoffMinute: number
Read Only:
trueIndicates the minute associated with the cutoff time for the current day, after which orders can't be shipped from the facility. The cutoff time can be defined for an organization, a carrier, or a combination of these attributes. -
CutoffTime: number
Read Only:
trueIndicates the time associated with the cutoff time for the current day, after which orders can't be shipped from the facility. The cutoff time can be defined for an organization, a carrier, or a combination of these attributes. -
DefaultLocationCode: string
Read Only:
trueMaximum Length:150Abbreviation of the default location for the organization. -
DefaultLocationDescription: string
Read Only:
trueMaximum Length:2000Description of the default location for the organization. -
DefaultLocationName: string
Read Only:
trueMaximum Length:240Name of the default location for the organization -
DropShipValidationOrganization: string
Read Only:
trueMaximum Length:4000Indicates whether the organization is used as the validation organization for drop ship orders. Values include Yes and No. -
DropShipValidationOrganizationCode: integer
(int32)
Read Only:
trueAbbreviation indicating whether the organization is used as the validation organization for drop ship orders. Values include 1 for Yes and 2 for No. -
ExternalManufacturerSupplies: number
Read Only:
trueIndicates if the organization uses external manufacturer supplies in planning. -
FixedDateIndicator: integer
(int32)
Read Only:
trueValue that indicates whether the organization uses the fixed date defined in the MSC_FIXED_DATE profile option under the Manage Planning Profile Options task. -
GlobalForecastValidationOrganizationCode: integer
(int32)
Read Only:
trueAbbreviation indicating that the organization is referenced for item attributes and bills of material in forecasts that don't have an associated organization. -
GlobalForecastValidationOrganizationIndicator: number
Read Only:
trueIndicates whether the organization is referenced for item attributes and bills of material in forecasts that don't have an associated organization. -
InventoryOrganization: string
Read Only:
trueMaximum Length:4000Name of the inventory organization. -
InventoryOrganizationCode: number
Read Only:
trueAbbreviation that identifies the inventory organization. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MasterOrganizationCode: string
Read Only:
trueMaximum Length:4000Abbreviation that identifies the master organization for the organization. -
MasterOrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the master organization for the organization. -
NotesCount: integer
Read Only:
trueNumber of notes associated with the organization. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueImplements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried. -
OrganizationCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the organization. -
OrganizationGroup: string
Read Only:
trueMaximum Length:30Name of the organization group for the organization. -
OrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the organization. -
OrganizationName: string
Read Only:
trueMaximum Length:240Name of the to organization. -
PastDueForecastDays: number
Read Only:
trueNumber of days of past-due forecasts to include in plans. -
PastDueSalesOrderDays: integer
(int32)
Read Only:
trueNumber of days before the plan start date to include as a past-due sales order. -
PastDueSupplyDays: integer
(int32)
Read Only:
trueNumber of days before the plan start date to include as past-due supply. -
PickPackLeadTime: number
Read Only:
trueValue that identifies the time needed to pick and pack an item. The pick and pack lead time can be specified for an organization, carrier, or a combination of the organization and the airline. -
PlanComponentsSupplyTypeBulk: number
Read Only:
trueIndicates whether planning uses components with a supply type of Bulk for the organization. Values include null, 1 for Yes, and 2 for No. -
PlanComponentsSupplyTypeSupplier: number
Read Only:
trueIndicates whether planning uses components with a supply type of Supplier for the organization. Values include null, 1 for Yes, and 2 for No. -
ProjectControlLevel: number
Read Only:
trueIndicates whether the project control level of an organization is set to Project or Project and Task. -
ProjectReference: string
Read Only:
trueMaximum Length:4000Indicates whether the project reference is enabled. Valid values are Yes and No. -
ProjectReferenceEnabled: number
Read Only:
trueIndicates whether the project reference is enabled. Valid values are 1 for Yes and 2 for No. The default value is No. -
SourceCalendarCode: string
Read Only:
trueMaximum Length:32Abbreviation that identifies the source calendar. -
SourceInstanceId: number
Read Only:
trueValue that uniquely identifies the source system in which the demand originated. -
SourceOrganizationCode: string
Read Only:
trueMaximum Length:18Abbreviation that identifies the source organization from which an item is planned. -
SourceSystemCode: string
Read Only:
trueMaximum Length:30Value that identifies the source system of the organization. -
SourceSystemId: integer
(int64)
Read Only:
trueUniquely identifies the source system. -
SubinventoryPlanning: string
Read Only:
trueMaximum Length:4000Indicates whether the organization is enabled for subinventory-level planning. Values include Yes and No. -
SubinventoryPlanningCode: number
Read Only:
trueIndicates whether the organization is enabled for subinventory-level planning. Values include 1 for Yes and 2 for No. -
SupplierId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier assigned to the organization. -
SupplierName: string
Read Only:
trueMaximum Length:4000Name of the supplier assigned to the organization. -
SupplierSiteCode: string
Read Only:
trueMaximum Length:4000Abbreviation for the supplier site assigned to the organization. -
SupplierSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site assigned to the organization. -
TimeZoneCode: string
Read Only:
trueMaximum Length:64Abbreviation that identifies the time zone assigned to the organization. -
TimeZoneName: string
Read Only:
trueMaximum Length:255Name of the time zone assigned to the organization. -
TimeZoneShortName: string
Read Only:
trueMaximum Length:80Abbreviation of the time zone assigned to the organization. -
VolumeUnitOfMeasureCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the unit of measure for volume. -
VolumeUnitOfMeasureName: string
Read Only:
trueMaximum Length:25Name of the unit of measure for volume.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : supplyNetworkOrganizations-AdditionalInformationDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.