Jump to

• Request
• Response

Flat json structure for Measure Quantities

get

/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemands/measureQuantities

Get flat json of measure quantities

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
    Finder Variables:
    • CustomerDemandId
• 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
• 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:
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Headers

• 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 : collaborationCustomerDemands-flatMeasureQuantities

Match All

Show Source

• object CollectionProperties
• object collaborationCustomerDemands-flatMeasureQuantities-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CollectionProperties"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "title":"Items",
                    "type":"array",
                    "description":"The items in the collection.",
                    "items":{
                        "$ref":"#/components/schemas/collaborationCustomerDemands-flatMeasureQuantities-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionProperties

Type: object

Show Source

• 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.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : collaborationCustomerDemands-flatMeasureQuantities-allOf[1]

Type: object

Show Source

• items: array Items
  Title: Items

  The items in the collection.

{
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/collaborationCustomerDemands-flatMeasureQuantities-item-response"
            }
        }
    }
}

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: collaborationCustomerDemands-flatMeasureQuantities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/collaborationCustomerDemands-flatMeasureQuantities-item-response"
    }
}

Nested Schema : collaborationCustomerDemands-flatMeasureQuantities-item-response

Match All

Show Source

• object ItemProperties
• object collaborationCustomerDemands-flatMeasureQuantities-item
• object collaborationCustomerDemands-flatMeasureQuantities-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/collaborationCustomerDemands-flatMeasureQuantities-item"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : collaborationCustomerDemands-flatMeasureQuantities-item

Type: object

Show Source

• CurrentCycleFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the measure quantities are in the current planning cycle. If false, then the measure quantities have been expired and are in the previous planning cycle. This attribute does not have a default value.
• CustomerDemandId: integer
  Title: Customer Demand Request ID

  Read Only: true

  Value that uniquely identifies the customer demand request.
• CustomerName: string
  Title: Customer Name

  Maximum Length: 360

  Name of the customer that receives the item.
• CustomerSiteNumber: string
  Title: Customer Site Number

  Maximum Length: 30

  Number of the customer site that receives the item.
• Date: string
• DocumentTypeCode: string
  Title: Document Type Code

  Maximum Length: 30

  Abbreviation that identifies the type of document used for collaboration.
• DocumentTypeName: string
  Title: Document Type Name

  Read Only: true

  Maximum Length: 300

  Type of document used for collaboration.
• ItemLevelValue: string
  Title: Item Level Value

  Maximum Length: 300

  Value that identifies the item level of the customer demand request.
• MeasureQuantitiesId: integer (int64)
  Read Only: true

  Date on the measure.
• MeasureTypeCode: string
  Title: Measure Type Code

  Maximum Length: 18

  Abbreviation that identifies the type of measure used for collaboration within a document.
• OrganizationLevelValue: string
  Title: Item Level Value

  Maximum Length: 49

  Value that identifies the organization level of the customer demand request.
• Quantity: number
  Quantity for a specified date on the measure.

{
    "type":"object",
    "properties":{
        "CustomerDemandId":{
            "title":"Customer Demand Request ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer demand request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18",
                "adf-hasDefaultValueExpression":true
            }
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "DocumentTypeName":{
            "title":"Document Type Name",
            "maxLength":"300",
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CustomerName":{
            "title":"Customer Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer that receives the item.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "CustomerSiteNumber":{
            "title":"Customer Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number of the customer site that receives the item.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "OrganizationLevelValue":{
            "title":"Item Level Value",
            "maxLength":"49",
            "type":"string",
            "description":"Value that identifies the organization level of the customer demand request.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ItemLevelValue":{
            "title":"Item Level Value",
            "maxLength":"300",
            "type":"string",
            "description":"Value that identifies the item level of the customer demand request.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the type of measure used for collaboration within a document.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity for a specified date on the measure.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "CurrentCycleFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the measure quantities are in the current planning cycle. If false, then the measure quantities have been expired and are in the previous planning cycle. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Date":{
            "type":"string",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MeasureQuantitiesId":{
            "type":"integer",
            "description":"Date on the measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        }
    }
}

Nested Schema : collaborationCustomerDemands-flatMeasureQuantities-item-response-allOf[2]

Type: object

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

Back to Top