Jump to

• Request
• Response

Update one site schedule

patch

/fscmRestApi/resources/11.13.18.05/transportationSchedules/{TransportationScheduleAssignmentId}/child/SiteSchedules/{TransportationScheduleAssignmentId2}

Request

Path Parameters

• TransportationScheduleAssignmentId(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=
• TransportationScheduleAssignmentId2(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CarrierId: integer (int64)
  Value that uniquely identifies the carrier.
• DFF: array DFF
• EnabledFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the transportation schedule is enabled. If false, then the transportation schedule isn't enabled. This attribute doesn't have a default value.
• LocationId: integer (int64)
  Unique identifier of the location.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• PartyId: integer (int64)
  Unique identifier of the organization or person.
• PartySiteId: integer (int64)
  Unique identifier of the party site.
• ScheduleId: integer (int64)
  Unique identifier of the schedule.
• ScheduleUsageCode: string
  Title: Schedule Usage

  Maximum Length: 10

  Abbreviation that indicates usage type of the transportation schedule assignment. A list of accepted values is defined in the lookup type WSH_SCHEDULE_USAGE.
• TradingPartnerTypeCode: string
  Title: Trading Partner Type

  Maximum Length: 20

  Abbreviation that identifies the trading partner type. A list of accepted values is defined in the lookup type WSH_TRADING_PARTNER_TYPE.

{
    "type":"object",
    "properties":{
        "TradingPartnerTypeCode":{
            "title":"Trading Partner Type",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the trading partner type. A list of accepted values is defined in the lookup type WSH_TRADING_PARTNER_TYPE.",
            "nullable":false
        },
        "CarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"Unique identifier of the organization or person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ScheduleUsageCode":{
            "title":"Schedule Usage",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that indicates usage type of the transportation schedule assignment. A list of accepted values is defined in the lookup type WSH_SCHEDULE_USAGE.",
            "nullable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transportationSchedules-SiteSchedules-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier of the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the transportation schedule is enabled. If false, then the transportation schedule isn't enabled. This attribute doesn't have a default value.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"default"
            }
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object transportationSchedules-SiteSchedules-DFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/transportationSchedules-SiteSchedules-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : transportationSchedules-SiteSchedules-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : transportationSchedules-SiteSchedules-item-response

Type: object

Show Source

• CarrierId: integer (int64)
  Value that uniquely identifies the carrier.
• DFF: array DFF
• EnabledFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the transportation schedule is enabled. If false, then the transportation schedule isn't enabled. This attribute doesn't have a default value.
• FormattedAddress: string
  Title: Address

  Read Only: true

  Address of the location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Unique identifier of the location.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• PartyId: integer (int64)
  Unique identifier of the organization or person.
• PartySiteId: integer (int64)
  Unique identifier of the party site.
• PartySiteName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  Name of the party site.
• ScheduleAssignmentCode: string
  Maximum Length: 100

  Abbreviation that identifies the transportation schedule assignment to a trading partner site.
• ScheduleId: integer (int64)
  Unique identifier of the schedule.
• ScheduleName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the schedule.
• ScheduleUsageCode: string
  Title: Schedule Usage

  Maximum Length: 10

  Abbreviation that indicates usage type of the transportation schedule assignment. A list of accepted values is defined in the lookup type WSH_SCHEDULE_USAGE.
• TradingPartnerSite: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the trading partner's location.
• TradingPartnerSiteAddress: string
  Read Only: true

  Maximum Length: 255

  Address of the trading partner's location.
• TradingPartnerTypeCode: string
  Title: Trading Partner Type

  Maximum Length: 20

  Abbreviation that identifies the trading partner type. A list of accepted values is defined in the lookup type WSH_TRADING_PARTNER_TYPE.
• TransportationScheduleAssignmentId: integer (int64)
  Unique identifier of the transportation schedule assignment to a trading partner site.

{
    "type":"object",
    "properties":{
        "TradingPartnerTypeCode":{
            "title":"Trading Partner Type",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the trading partner type. A list of accepted values is defined in the lookup type WSH_TRADING_PARTNER_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "TradingPartnerSiteAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the trading partner's location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartySiteId"
                ]
            },
            "x-queryable":true
        },
        "TransportationScheduleAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the transportation schedule assignment to a trading partner site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transportationSchedules-SiteSchedules-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"Address of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier of the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleAssignmentCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the transportation schedule assignment to a trading partner site.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradingPartnerSite":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the trading partner's location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Unique identifier of the organization or person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleUsageCode":{
            "title":"Schedule Usage",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that indicates usage type of the transportation schedule assignment. A list of accepted values is defined in the lookup type WSH_SCHEDULE_USAGE.",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the party site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the transportation schedule is enabled. If false, then the transportation schedule isn't enabled. This attribute doesn't have a default value.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object transportationSchedules-SiteSchedules-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/transportationSchedules-SiteSchedules-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : transportationSchedules-SiteSchedules-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CalendarAssignmentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CalendarAssignmentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/transportationSchedules/{TransportationScheduleAssignmentId}/child/SiteSchedules/{TransportationScheduleAssignmentId2}/child/DFF

Parameters:

• TransportationScheduleAssignmentId: $request.path.TransportationScheduleAssignmentId
• TransportationScheduleAssignmentId2: $request.path.TransportationScheduleAssignmentId2

Back to Top