Jump to

• Request
• Response
• Examples

Create details

post

/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastRequests/{CollaborationOrderForecastRequestId}/child/details

Request

Path Parameters

• CollaborationOrderForecastRequestId(required): string
  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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BucketStartDate: string (date)
  Date when the time bucket starts.
• CollaborationOrderForecastRequestId: string
  Maximum Length: 18

  Value that uniquely identifies the request for the collaboration order forecast.
• PublisherOrderTypeCode: string
  Maximum Length: 32

  Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• Quantity: number
  Quantity of the publisher order type.
• ReferenceHeaderId: integer (int64)
  Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceHeaderNumber: string
  Maximum Length: 64

  Reference header number for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineId: integer (int64)
  Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineLocationId: integer (int64)
  Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineLocationNumber: string
  Maximum Length: 64

  Number that identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineNumber: string
  Maximum Length: 64

  Number that identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.

{
    "type":"object",
    "properties":{
        "PublisherOrderTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":false
        },
        "ReferenceHeaderNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Reference header number for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "nullable":true,
            "x-queryable":false
        },
        "CollaborationOrderForecastRequestId":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "nullable":true
        },
        "ReferenceLineNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Number that identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the publisher order type.",
            "nullable":false
        },
        "ReferenceLineLocationNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Number that identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "nullable":true,
            "x-queryable":false
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false
        },
        "ReferenceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReferenceLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReferenceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : collaborationOrderForecastRequests-details-item-response

Type: object

Show Source

• BucketStartDate: string (date)
  Date when the time bucket starts.
• CollaborationOrderForecastRequestId: string
  Maximum Length: 18

  Value that uniquely identifies the request for the collaboration order forecast.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PublisherOrderTypeCode: string
  Maximum Length: 32

  Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
• Quantity: number
  Quantity of the publisher order type.
• ReferenceHeaderId: integer (int64)
  Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceHeaderNumber: string
  Maximum Length: 64

  Reference header number for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineId: integer (int64)
  Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineLocationId: integer (int64)
  Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineLocationNumber: string
  Maximum Length: 64

  Number that identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.
• ReferenceLineNumber: string
  Maximum Length: 64

  Number that identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.

{
    "type":"object",
    "properties":{
        "PublisherOrderTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the order type of the reference quantity. A list of accepted values is defined in the lookup type ORA_VCS_COLLAB_ORDER_TYPES. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceHeaderNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Reference header number for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "nullable":true,
            "x-queryable":false
        },
        "CollaborationOrderForecastRequestId":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that uniquely identifies the request for the collaboration order forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceLineNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Number that identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the publisher order type.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceLineLocationNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Number that identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the time bucket starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference line for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReferenceLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference line location for a measure that originates outside of Oracle Cloud. A measure that doesn't originate in Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReferenceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference header for a measure that originates in the Oracle Cloud. A measure that doesn't originate in the Oracle Cloud must use the Reference Header Number column. You must use a reference header, line, and location for each read-only reference measure. A purchase order is an example of a reference measure.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Examples

This example describes how to create details.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/collaborationOrderForecastRequests/CollaborationOrderForecastRequestId/child/details"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
 "PublisherOrderTypeCode": "ON_HAND",
 "BucketStartDate": "2018-06-20",
 "Quantity": 100
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "CollaborationOrderForecastRequestId": "783974963883401",
    "PublisherOrderTypeCode": "ON_HAND",
    "BucketStartDate": "2018-06-20",
    "Quantity": 100,
    "ReferenceHeaderId": null,
    "ReferenceLineId": null,
    "ReferenceLineLocationId": null,
    "ReferenceHeaderNumber": null,
    "ReferenceLineNumber": null,
    "ReferenceLineLocationNumber": null,
    "links": [
        {
            ...
        },
        {
            ...
        },
        {
            ...
        }
    ]
}

Back to Top