Jump to

• Request
• Response

Get one flow sequencing rule

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/flowSequencingRules/{FlowSequencingRuleId}

Request

Path Parameters

• FlowSequencingRuleId(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=
• OrganizationId(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 : productionSchedulingOrganizations-flowSequencingRules-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then apply the flow sequencing rule. If false, then don't apply the flow sequencing rule. This attribute doesn't have a default value.
• AttributeCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the attribute that's enabled for scheduling.
• AttributeDescription: string
  Read Only: true

  Maximum Length: 2000

  Description of the associated attribute.
• AttributeId: integer (int64)
  Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.
• AttributeValueCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the attribute value.
• AttributeValueId: integer (int64)
  Value that uniquely identifies the attribute value. It's a primary key of the attribute value.
• AttributeValueName: string
  Read Only: true

  Maximum Length: 300

  Name of the attribute value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the resource attribute sequence.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the resource attribute sequence.
• DescriptiveFlexfieldCode: string
  Read Only: true

  Maximum Length: 40

  Abbreviation that identifies the descriptive flexfield used in Oracle Manufacturing Cloud for scheduling attributes of the organization.
• FlexfieldContextCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the flexfield context code used in Oracle Manufacturing Cloud for scheduling attributes of the organization.
• FlowSequencingRuleId: integer (int64)
  Value that uniquely identifies the flow sequencing rule. It's a primary key of the flow sequencing rule.
• KValue: integer (int64)
  Value that identifies the count limit of the defined attribute considered in the flow sequencing rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the resource attribute sequence.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the resource attribute sequence.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the resource attribute sequence.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NValue: integer (int64)
  Value that identifies the count limit of the defined attribute considered in the flow sequencing rule.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• PreviousAttributeValueCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the attribute value of the previous attribute in the flow sequencing rule.
• PreviousAttributeValueId: integer (int64)
  Value that uniquely identifies the previous attribute value. It's a primary key of the previous attribute value.
• PreviousAttributeValueName: string
  Read Only: true

  Maximum Length: 300

  Name of the previous attribute value.
• ProductionLineCode: string
  Maximum Length: 30

  Abbreviation that identifies the production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies the production line.
• ProductionLineName: string
  Maximum Length: 120

  Name of the production line.
• RuleName: string
  Maximum Length: 240

  Name of the flow sequencing rule.
• RulePriority: number
  Priority of the flow sequencing rule.
• RuleType: string
  Maximum Length: 32

  Type of flow sequencing rule for an attribute and its value.
• RunSizeLimit: integer (int64)
  Maximum number of attributes that can be contiguously sequenced in a production run.
• SegmentCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the segment used in Oracle Manufacturing Cloud for scheduling attributes of the organization.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then apply the flow sequencing rule. If false, then don't apply the flow sequencing rule. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute that's enabled for scheduling.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the associated attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute value. It's a primary key of the attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the resource attribute sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the resource attribute sequence.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DescriptiveFlexfieldCode":{
            "maxLength":40,
            "type":"string",
            "description":"Abbreviation that identifies the descriptive flexfield used in Oracle Manufacturing Cloud for scheduling attributes of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlexfieldContextCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the flexfield context code used in Oracle Manufacturing Cloud for scheduling attributes of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowSequencingRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the flow sequencing rule. It's a primary key of the flow sequencing rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "KValue":{
            "type":"integer",
            "description":"Value that identifies the count limit of the defined attribute considered in the flow sequencing rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the resource attribute sequence.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the resource attribute sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the resource attribute sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NValue":{
            "type":"integer",
            "description":"Value that identifies the count limit of the defined attribute considered in the flow sequencing rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviousAttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute value of the previous attribute in the flow sequencing rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the previous attribute value. It's a primary key of the previous attribute value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviousAttributeValueName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the previous attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductionLineCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the flow sequencing rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RulePriority":{
            "type":"number",
            "description":"Priority of the flow sequencing rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleType":{
            "maxLength":32,
            "type":"string",
            "description":"Type of flow sequencing rule for an attribute and its value.",
            "nullable":false,
            "x-queryable":true
        },
        "RunSizeLimit":{
            "type":"integer",
            "description":"Maximum number of attributes that can be contiguously sequenced in a production run.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SegmentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the segment used in Oracle Manufacturing Cloud for scheduling attributes of the organization.",
            "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