Jump to

• Request
• Response

Mass update a collection of relationships

post

/fscmRestApi/resources/11.13.18.05/collaborationRelationships/action/massUpdate

Mass update a collection of relationships in supply collaboration.

Request

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/vnd.oracle.adf.action+json

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

Root Schema : schema

Type: object

Show Source

• AdjustCommits: string
  Contains Y or N. If Y, then the ship-to supplier can adjust commits for their suppliers. If N, then this supplier can't make this adjustment. The default value is N. This attribute is applicable only to each relationship where the ship-to organization is a contract manufacturer and the View Order Forecasts option is Y.
• AdjustOrderForecasts: string
  Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer and the View Order Forecasts option is Y.
• CollaborationUOMCode: string
  Abbreviation that identifies the unit of measure used for supply chain collaboration.
• CollaborationUOMSourceCode: string
  Abbreviation that identifies the source for the unit of measure that's available for supply chain collaboration. Values include ORA_VCS_UOMSOURCE_PUB, ORA_VCS_UOMSOURCE_ASL, ORA_VCS_UOMSOURCE_PRI, or ORA_VCS_UOMSOURCE_OTH.
• CommitHorizonInDays: number
  Number of days in the future that the order forecast will contain commit quantities.
• CommitHorizonInDaysAction: string
  Abbreviation that identifies the mass update action to be taken against the CommitHorizonInDays attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• CommitPeriod: string
  Time period when the process must provide commit quantities to the enterprise. This attribute can contain one of the following values: Commit Horizon or Days. This attribute is used when SLA Action is Commit Automatically.
• CommitPeriodAction: string
  Abbreviation that identifies the mass update action to be taken against the CommitPeriod attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• CommitPeriodDays: string
  Number of days in the future to provide commit quantities to the enterprise. This attribute is used when the commit period is days.
• CommitQuantity: string
  Quantity provided to the enterprise when the process reaches the action that the service level agreement specifies. Valid values include Previous Forecast Commits or Percentage of Current Forecast. This attribute is used when the Commit Period value is set.
• CommitQuantityAction: string
  Abbreviation that identifies the mass update action to be taken against the CommitQuantity attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• CommitQuantityPercentage: string
  Percent of the current forecast to commit. This attribute is used when the commit quantity contains percent of current forecast. The default value is 100.
• CommitSlaInDays: number
  Number of days from the publish date that the supplier must commit for an order forecast.
• CommitSlaInDaysAction: string
  Abbreviation that identifies the mass update action to be taken against the CommitSlaInDays attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• EffectiveEndDate: string
  Date the relationship becomes inactive.
• EffectiveEndDateAction: string
  Abbreviation that identifies the mass update action to be taken against the EffectiveEndDate attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• EffectiveStartDate: string
  Date the relationship becomes active.
• EffectiveStartDateAction: string
  Abbreviation that identifies the mass update action to be taken against the EffectiveStartDate attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• ForecastHorizonInDays: number
  Number of days in the future that the order forecast will contain forecast quantities.
• ForecastHorizonInDaysAction: string
  Abbreviation that identifies the mass update action to be taken against the ForecastHorizonInDays attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• ManufacturerName: string
  Name of the manufacturer.
• ManufacturerPartNumber: string
  Number that identifies the item at the manufacturer.
• RelationshipIdArray: array RelationshipIdArray
  Name of the array that contains a comma separated list of relationship IDs to update.
• SlaAction: string
  Action that the application takes when it reaches the service level agreement. This attribute is empty or can contain a value of Commit Automatically. The default value is empty. This attribute is used when the Commit SLA in Days is a positive whole number.
• SlaValue: string
  Abbreviation that identifies the mass update action to be taken against the SlaAction attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.
• ViewOrderForecasts: string
  Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer.

{
    "type":"object",
    "properties":{
        "CommitQuantity":{
            "type":"string",
            "description":"Quantity provided to the enterprise when the process reaches the action that the service level agreement specifies. Valid values include Previous Forecast Commits or Percentage of Current Forecast. This attribute is used when the Commit Period value is set.",
            "nullable":true
        },
        "CommitSlaInDays":{
            "type":"number",
            "description":"Number of days from the publish date that the supplier must commit for an order forecast.",
            "nullable":true
        },
        "CommitHorizonInDays":{
            "type":"number",
            "description":"Number of days in the future that the order forecast will contain commit quantities.",
            "nullable":true
        },
        "ForecastHorizonInDays":{
            "type":"number",
            "description":"Number of days in the future that the order forecast will contain forecast quantities.",
            "nullable":true
        },
        "CommitQuantityAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the CommitQuantity attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "EffectiveStartDateAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the EffectiveStartDate attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "EffectiveEndDateAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the EffectiveEndDate attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "RelationshipIdArray":{
            "type":"array",
            "description":"Name of the array that contains a comma separated list of relationship IDs to update.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "CommitPeriodAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the CommitPeriod attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "CommitPeriodDays":{
            "type":"string",
            "description":"Number of days in the future to provide commit quantities to the enterprise. This attribute is used when the commit period is days.",
            "nullable":true
        },
        "SlaValue":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the SlaAction attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "AdjustOrderForecasts":{
            "type":"string",
            "description":"Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer and the View Order Forecasts option is Y.",
            "nullable":true
        },
        "CommitQuantityPercentage":{
            "type":"string",
            "description":"Percent of the current forecast to commit. This attribute is used when the commit quantity contains percent of current forecast. The default value is 100.",
            "nullable":true
        },
        "CollaborationUOMSourceCode":{
            "type":"string",
            "description":"Abbreviation that identifies the source for the unit of measure that's available for supply chain collaboration. Values include ORA_VCS_UOMSOURCE_PUB, ORA_VCS_UOMSOURCE_ASL, ORA_VCS_UOMSOURCE_PRI, or ORA_VCS_UOMSOURCE_OTH.",
            "nullable":true
        },
        "SlaAction":{
            "type":"string",
            "description":"Action that the application takes when it reaches the service level agreement. This attribute is empty or can contain a value of Commit Automatically. The default value is empty. This attribute is used when the Commit SLA in Days is a positive whole number.",
            "nullable":true
        },
        "ManufacturerName":{
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date the relationship becomes inactive.",
            "nullable":true
        },
        "CommitSlaInDaysAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the CommitSlaInDays attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "ManufacturerPartNumber":{
            "type":"string",
            "description":"Number that identifies the item at the manufacturer.",
            "nullable":true
        },
        "CollaborationUOMCode":{
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure used for supply chain collaboration.",
            "nullable":true
        },
        "ForecastHorizonInDaysAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the ForecastHorizonInDays attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date the relationship becomes active.",
            "nullable":true
        },
        "CommitHorizonInDaysAction":{
            "type":"string",
            "description":"Abbreviation that identifies the mass update action to be taken against the CommitHorizonInDays attribute. Acceptable values include ORA_VCS_SET_TO_VALUE and ORA_VCS_CLEAR_VALUE.",
            "nullable":true
        },
        "AdjustCommits":{
            "type":"string",
            "description":"Contains Y or N. If Y, then the ship-to supplier can adjust commits for their suppliers. If N, then this supplier can't make this adjustment. The default value is N. This attribute is applicable only to each relationship where the ship-to organization is a contract manufacturer and the View Order Forecasts option is Y.",
            "nullable":true
        },
        "CommitPeriod":{
            "type":"string",
            "description":"Time period when the process must provide commit quantities to the enterprise. This attribute can contain one of the following values: Commit Horizon or Days. This attribute is used when SLA Action is Commit Automatically.",
            "nullable":true
        },
        "ViewOrderForecasts":{
            "type":"string",
            "description":"Contains Y or N. If Y, then the ship-to supplier can view order forecasts for their suppliers. If N, then this supplier can't view these forecasts. The default value is N. This attribute is applicable to each relationship when the ship-to organization is a contract manufacturer.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : RelationshipIdArray

Type: array

Name of the array that contains a comma separated list of relationship IDs to update.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Name of the array that contains a comma separated list of relationship IDs to update.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Value that indicates if the action was successful.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Value that indicates if the action was successful."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Value that indicates if the action was successful."
}

Value that indicates if the action was successful.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top