Jump to

• Request
• Response

Create one group

post

/fscmRestApi/resources/11.13.18.05/buyerPlanningGroupDetails

A POST to create a group and assign to one or more orders.

Request

Header Parameters

• Metadata-Context(required):
  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(required):
  The protocol version between a REST client and service. If the client doesn't specify this header in the request the server picks a default version for the API.

Supported Media Types

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• GroupOrders: array GroupOrders
• ImplementDockDate: string
  Date when the material should be on the receiving dock when the order is released.
• IsNewGrpCodeFlag: string
  Indicates whether or not the group is new or already exists. The values can be Y or N. If the value is N, then the group already exists.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization associated with the order.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the specific supplier site from where the item is being sourced.

{
    "type":"object",
    "properties":{
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64"
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64"
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specific supplier site from where the item is being sourced.",
            "format":"int64"
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization associated with the order.",
            "format":"int64"
        },
        "ImplementDockDate":{
            "type":"string",
            "description":"Date when the material should be on the receiving dock when the order is released."
        },
        "IsNewGrpCodeFlag":{
            "type":"string",
            "description":"Indicates whether or not the group is new or already exists.  The values can be Y or N. If the value is N, then the group already exists."
        },
        "GroupOrders":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "TransactionId":{
                        "type":"integer",
                        "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
                        "format":"int64"
                    },
                    "PartKey":{
                        "type":"integer",
                        "description":"Number that indicates the source application instance identifier of the item organization.",
                        "format":"int64"
                    },
                    "if-match":{
                        "type":"string",
                        "description":"Type of conditional request header used to confirm a records latest version."
                    }
                }
            }
        }
    }
}

Nested Schema : GroupOrders

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "TransactionId":{
                "type":"integer",
                "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
                "format":"int64"
            },
            "PartKey":{
                "type":"integer",
                "description":"Number that indicates the source application instance identifier of the item organization.",
                "format":"int64"
            },
            "if-match":{
                "type":"string",
                "description":"Type of conditional request header used to confirm a records latest version."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• if-match: string
  Type of conditional request header used to confirm a records latest version.
• PartKey: integer (int64)
  Number that indicates the source application instance identifier of the item organization.
• TransactionId: integer (int64)
  Value that uniquely identifies the supply transaction. This value is internally generated by the application.

{
    "type":"object",
    "properties":{
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "format":"int64"
        },
        "PartKey":{
            "type":"integer",
            "description":"Number that indicates the source application instance identifier of the item organization.",
            "format":"int64"
        },
        "if-match":{
            "type":"string",
            "description":"Type of conditional request header used to confirm a records latest version."
        }
    }
}

Request Body - application/vnd.oracle.adf.resourceitem+json ()

Root Schema : schema

Type: object

Show Source

• GroupOrders: array GroupOrders
• ImplementDockDate: string
  Date when the material should be on the receiving dock when the order is released.
• IsNewGrpCodeFlag: string
  Indicates whether or not the group is new or already exists. The values can be Y or N. If the value is N, then the group already exists.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization associated with the order.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the specific supplier site from where the item is being sourced.

{
    "type":"object",
    "properties":{
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64"
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64"
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specific supplier site from where the item is being sourced.",
            "format":"int64"
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization associated with the order.",
            "format":"int64"
        },
        "ImplementDockDate":{
            "type":"string",
            "description":"Date when the material should be on the receiving dock when the order is released."
        },
        "IsNewGrpCodeFlag":{
            "type":"string",
            "description":"Indicates whether or not the group is new or already exists.  The values can be Y or N. If the value is N, then the group already exists."
        },
        "GroupOrders":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "TransactionId":{
                        "type":"integer",
                        "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
                        "format":"int64"
                    },
                    "PartKey":{
                        "type":"integer",
                        "description":"Number that indicates the source application instance identifier of the item organization.",
                        "format":"int64"
                    },
                    "if-match":{
                        "type":"string",
                        "description":"Type of conditional request header used to confirm a records latest version."
                    }
                }
            }
        }
    }
}

Nested Schema : GroupOrders

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "TransactionId":{
                "type":"integer",
                "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
                "format":"int64"
            },
            "PartKey":{
                "type":"integer",
                "description":"Number that indicates the source application instance identifier of the item organization.",
                "format":"int64"
            },
            "if-match":{
                "type":"string",
                "description":"Type of conditional request header used to confirm a records latest version."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• if-match: string
  Type of conditional request header used to confirm a records latest version.
• PartKey: integer (int64)
  Number that indicates the source application instance identifier of the item organization.
• TransactionId: integer (int64)
  Value that uniquely identifies the supply transaction. This value is internally generated by the application.

{
    "type":"object",
    "properties":{
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "format":"int64"
        },
        "PartKey":{
            "type":"integer",
            "description":"Number that indicates the source application instance identifier of the item organization.",
            "format":"int64"
        },
        "if-match":{
            "type":"string",
            "description":"Type of conditional request header used to confirm a records latest version."
        }
    }
}

Back to Top

Response

Default Response

#/responses/buyerPlanningGroupDetails-single-response

Back to Top