Get all organizations

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations

Request

Query Parameters
  • 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).
  • 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
  • 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 Find production scheduling organizations according to the organization identifier.
      Finder Variables
      • OrganizationId; integer; Value that uniquely identifies the organization.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CreatedBy; string; User who initiated the refresh.
    • CreationDate; string; Date and time when the user created the request.
    • LastUpdateDate; string; Date and time when the user most recently updated the organization data.
    • LastUpdateLogin; string; Login that the user used when updating the organization.
    • LastUpdatedBy; string; User who most recently updated the organization data.
    • MaintenanceEnabledFlag; boolean; Contains one of the following values: Yes or No. If Yes, then the plan is setup to schedule maintenance work orders. If No, then the plan isn't setup to schedule maintenance work orders. The default value is No.
    • OrganizationCode; string; Abbreviation that identifies the inventory organization that's enabled for scheduling.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
    • OrganizationName; string; Name of the inventory organization that's enabled for scheduling.
    • RefreshEndDate; string; Date when the refresh ends.
    • RefreshErrorCode; integer; Abbreviation that identifies the error, if any, of the refresh request.
    • RefreshRequestId; integer; Value that uniquely identifies the request of the scheduled process. This attribute is used to track the status.
    • RefreshStartDate; string; Date when the refresh starts.
    • RefreshStatus; integer; Status of the refresh.
    • RequestInProcessFlag; boolean; Contains one of the following values: true or false. If true, then refresh is in process. If false, then refresh isn't in process. This attribute doesn't have a default value.
    • Timezone; string; Time zone of the organization.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : productionSchedulingOrganizations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : productionSchedulingOrganizations-item-response
Type: object
Show Source
Nested Schema : Attributes
Type: array
Title: Attributes
The Attributes resource manages the attributes by organization and normalizes the attributes that can be defined by manufacturing attribute groups and item class attribute groups.
Show Source
Nested Schema : Attribute Sequences
Type: array
Title: Attribute Sequences
The Attribute Sequences resource manages the user directed sequence in which an attribute should be processed on a manufacturing resource.
Show Source
Nested Schema : Changeover Rules
Type: array
Title: Changeover Rules
The Changeover Rules resource manages the changeovers which are defined by the organization. The changeovers define the from and to attributes in the manufacturing process, which can trigger a changeover time.
Show Source
Nested Schema : Item Class Attribute Groups
Type: array
Title: Item Class Attribute Groups
The Item Class Attribute Groups specifies attribute group code for an item business object.
Show Source
Nested Schema : Item Parameters
Type: array
Title: Item Parameters
The Item Parameters resource manages the definition of production scheduling specific item parameters.
Show Source
Nested Schema : Manufacturing Attribute Groups
Type: array
Title: Manufacturing Attribute Groups
The Manufacturing Attribute Groups specifies attribute code by manufacturing business object.
Show Source
Nested Schema : Resource Attributes
Type: array
Title: Resource Attributes
The Resource Attributes resource manages attributes that are relevant to a resource for a changeover consideration.
Show Source
Nested Schema : Resource Groups
Type: array
Title: Resource Groups
The Resource Groups resource manages the user defined groupings of resources that are used in simplifying changeover rule definition and user interface filtering.
Show Source
Nested Schema : Resource Parameters
Type: array
Title: Resource Parameters
The Resource Parameters resource manages the definition of production scheduling specific resource parameters that aren't defined in Oracle Manufacturing Cloud.
Show Source
Nested Schema : Resource Relationships
Type: array
Title: Resource Relationships
The Resource Relationships resource manages the upstream and downstream production resource relationships that describe how a product can be manufactured in a multistage production environment.
Show Source
Nested Schema : productionSchedulingOrganizations-attributes-item-response
Type: object
Show Source
Nested Schema : Attribute Values
Type: array
Title: Attribute Values
The Attribute Values resource manages the individual values that are defined by attribute group where a highlight color can also be defined to assist with visualization in the user interface.
Show Source
Nested Schema : productionSchedulingOrganizations-attributes-attributeValues-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-attributeSequences-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 300
    Abbreviation that identifies the attribute that's enabled for scheduling.
  • Read Only: true
    Maximum Length: 2000
    Description of the associated attribute.
  • Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.
  • Number that indicates the attribute sequence in the ideal sequence.
  • Attribute Value Sequences
    Title: Attribute Value Sequences
    The Attribute Value Sequences resource manages the user-specified sequence in which attribute values are processed in a manufacturing resource.
  • Read Only: true
    Maximum Length: 64
    User who created the resource attribute sequence.
  • Read Only: true
    Date and time when the user created the resource attribute sequence.
  • Maximum Length: 30
    Rule for the resource that defines the user-defined attribute sequence rule across scheduling buckets. Valid values are RestartSequence, ContinueSequence, and ReverseSequence.
  • Read Only: true
    Maximum Length: 40
    Abbreviation that identifies the descriptive flexfield used in Oracle Manufacturing Cloud for scheduling attributes of the organization.
  • Read Only: true
    Maximum Length: 80
    Abbreviation that identifies the flexfield context code used in Oracle Manufacturing Cloud for scheduling attributes of the organization.
  • Contains one of the following values: true or false. If true, then automatically generate attribute value sequences. If false, then don't automatically generate attribute value sequences. The default value is false.
  • Read Only: true
    Date and time when the user most recently updated the resource attribute sequence.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the resource attribute sequence.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the resource attribute sequence.
  • Links
  • Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
  • Maximum Length: 300
    Abbreviation that identifies the production resource.
  • Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.
  • Maximum Length: 120
    Name of the resource used to define the resource attribute sequence.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the segment used in Oracle Manufacturing Cloud for scheduling attributes of the organization.
  • Maximum Length: 100
    Abbreviation that identifies the work center.
  • Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.
  • Maximum Length: 120
    Name of the work center. This attribute is used to define the resource attribute sequence.
Nested Schema : Attribute Value Sequences
Type: array
Title: Attribute Value Sequences
The Attribute Value Sequences resource manages the user-specified sequence in which attribute values are processed in a manufacturing resource.
Show Source
Nested Schema : productionSchedulingOrganizations-attributeSequences-attributeValueSequences-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-changeoverRules-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-itemClassAttributeGroups-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-itemParameters-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-manufacturingAttributeGroups-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-resourceAttributes-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-resourceGroups-item-response
Type: object
Show Source
Nested Schema : Group Members
Type: array
Title: Group Members
The Group Members resource associates a resource to a resource group.
Show Source
Nested Schema : productionSchedulingOrganizations-resourceGroups-groupMembers-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-resourceParameters-item-response
Type: object
Show Source
Nested Schema : productionSchedulingOrganizations-resourceRelationships-item-response
Type: object
Show Source
Back to Top