Jump to

• Request
• Response

Get all schedule

get

/fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/schedules

Request

Path Parameters

• VersionId(required): integer
  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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 Finds purchase orders schedule changes according to the purchasing document changes schedule identifier as the primary key.
    Finder Variables
    • VersionId; integer; Value that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document schedule changes view object.
• 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionPerformed; string; Status for the action taken on the schedules of the purchase order.
  • AmountChanged; string; Value of the amount change requested on a change order for an order.
  • ChangeReason; string; Description for changing the document schedule.
  • ChangeStatus; string; Indicates what state the schedule in a pending change order is in relating to the entire change order lifecycle.
  • CurrencyCode; string; Abbreviation that identifies the currency of the purchase order.
  • Description; string; Description for the line item referenced to the schedule.
  • LineLocationId; integer; Value that uniquely identifies the purchase order schedule.
  • LineNumber; string; Value that uniquely identifies purchase order line referenced to schedule.
  • OldDescription; string; Description for previous line item referenced to the schedule.
  • OldLineNumber; string; Value that uniquely identifies the previous purchase order line.
  • OldPaymentType; string; Indicates the previous type of payment, whether it's based on units of work or a lump sum.
  • OldPromisedDeliveryDate; string; Date when the supplier initially promises to deliver the item to the buyer.
  • OldPromisedShipDate; string; Date when the supplier initially promised to ship the item to the buyer.
  • OldRequestedDeliveryDate; string; Date when the buyer initially requested that the supplier deliver the item.
  • OldRequestedShipDate; string; Date when the buyer initially requested the supplier to ship the item.
  • OldShipLocation; string; Name of the previous location where the supplier wanted to ship the item.
  • OldShipmentNumber; string; Value that uniquely identifies the previous purchase order schedule referenced to distribution.
  • PaymentType; string; Indicates the type of payment, whether it's based on units of work or a lump sum.
  • PromisedDeliveryDate; string; Date when the supplier promises to deliver the item to the buyer.
  • PromisedShipDate; string; Date when the supplier promises to ship the item to the buyer.
  • RequestedDeliveryDate; string; Date when the buyer requested that the supplier deliver the item.
  • RequestedShipDate; string; Date when the buyer requested that the supplier ship the item.
  • ShipToLocation; string; Name of the location where the supplier ships the item.
  • ShipmentNumber; string; Value that uniquely identifies the purchase order schedule referenced to distribution.
  • VersionId; integer; Value that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document schedule changes view object.
• 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: 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.

There's no request body for this operation.

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 : purchasingDocumentChanges-schedules

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.
• items: array Items
  Title: Items

  The items in the collection.
• 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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchasingDocumentChanges-schedules-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchasingDocumentChanges-schedules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchasingDocumentChanges-schedules-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 : purchasingDocumentChanges-schedules-item-response

Type: object

Show Source

• ActionPerformed: string
  Title: Action Performed

  Maximum Length: 255

  Status for the action taken on the schedules of the purchase order.
• AmountChanged: string
  Title: Amount Changed

  Maximum Length: 255

  Value of the amount change requested on a change order for an order.
• ChangeReason: string
  Title: Change Reason

  Maximum Length: 255

  Description for changing the document schedule.
• ChangeStatus: string
  Title: Change Status

  Maximum Length: 255

  Indicates what state the schedule in a pending change order is in relating to the entire change order lifecycle.
• CurrencyCode: string
  Maximum Length: 255

  Abbreviation that identifies the currency of the purchase order.
• Description: string
  Title: Description

  Maximum Length: 255

  Description for the line item referenced to the schedule.
• LineLocationId: integer
  Value that uniquely identifies the purchase order schedule.
• LineNumber: string
  Title: Line

  Maximum Length: 255

  Value that uniquely identifies purchase order line referenced to schedule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OldDescription: string
  Maximum Length: 255

  Description for previous line item referenced to the schedule.
• OldLineNumber: string
  Maximum Length: 255

  Value that uniquely identifies the previous purchase order line.
• OldPaymentType: string
  Title: Changed From

  Maximum Length: 255

  Indicates the previous type of payment, whether it's based on units of work or a lump sum.
• OldPromisedDeliveryDate: string (date)
  Title: Original Promised Delivery Date

  Date when the supplier initially promises to deliver the item to the buyer.
• OldPromisedShipDate: string (date)
  Date when the supplier initially promised to ship the item to the buyer.
• OldRequestedDeliveryDate: string (date)
  Date when the buyer initially requested that the supplier deliver the item.
• OldRequestedShipDate: string (date)
  Date when the buyer initially requested the supplier to ship the item.
• OldShipLocation: string
  Maximum Length: 255

  Name of the previous location where the supplier wanted to ship the item.
• OldShipmentNumber: string
  Maximum Length: 255

  Value that uniquely identifies the previous purchase order schedule referenced to distribution.
• PaymentType: string
  Maximum Length: 255

  Indicates the type of payment, whether it's based on units of work or a lump sum.
• PromisedDeliveryDate: string (date)
  Title: Promised Delivery Date

  Date when the supplier promises to deliver the item to the buyer.
• PromisedShipDate: string (date)
  Title: Promised Ship Date

  Date when the supplier promises to ship the item to the buyer.
• RequestedDeliveryDate: string
  Title: Requested Delivery Date

  Maximum Length: 255

  Date when the buyer requested that the supplier deliver the item.
• RequestedShipDate: string (date)
  Title: Requested Ship Date

  Date when the buyer requested that the supplier ship the item.
• ShipmentNumber: string
  Title: Shipment

  Maximum Length: 255

  Value that uniquely identifies the purchase order schedule referenced to distribution.
• ShipToLocation: string
  Title: Ship-to Location

  Maximum Length: 255

  Name of the location where the supplier ships the item.
• VersionId: integer
  Title: Version ID

  Value that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document schedule changes view object.

{
    "type":"object",
    "properties":{
        "OldRequestedShipDate":{
            "type":"string",
            "description":"Date when the buyer initially requested the supplier to ship the item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description for the line item referenced to the schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionPerformed":{
            "title":"Action Performed",
            "maxLength":255,
            "type":"string",
            "description":"Status for the action taken on the schedules of the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the purchase order schedule referenced to distribution.",
            "nullable":true,
            "x-queryable":true
        },
        "OldShipLocation":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the previous location where the supplier wanted to ship the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountChanged":{
            "title":"Amount Changed",
            "maxLength":255,
            "type":"string",
            "description":"Value of the amount change requested on a change order for an order.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies purchase order line referenced to schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "OldDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description for previous line item referenced to the schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeReason":{
            "title":"Change Reason",
            "maxLength":255,
            "type":"string",
            "description":"Description for changing the document schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "OldPromisedDeliveryDate":{
            "title":"Original Promised Delivery Date",
            "type":"string",
            "description":"Date when the supplier initially promises to deliver the item to the buyer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the currency of the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentType":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the type of payment, whether it's based on units of work or a lump sum.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionId":{
            "title":"Version ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document schedule changes view object.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeStatus":{
            "title":"Change Status",
            "maxLength":255,
            "type":"string",
            "description":"Indicates what state the schedule in a pending change order is in relating to the entire change order lifecycle.",
            "nullable":true,
            "x-queryable":true
        },
        "OldShipmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the previous purchase order schedule referenced to distribution.",
            "nullable":true,
            "x-queryable":true
        },
        "OldRequestedDeliveryDate":{
            "type":"string",
            "description":"Date when the buyer initially requested that the supplier deliver the item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OldPaymentType":{
            "title":"Changed From",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the previous type of payment, whether it's based on units of work or a lump sum.",
            "nullable":true,
            "x-queryable":true
        },
        "OldLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the previous purchase order line.",
            "nullable":true,
            "x-queryable":true
        },
        "PromisedDeliveryDate":{
            "title":"Promised Delivery Date",
            "type":"string",
            "description":"Date when the supplier promises to deliver the item to the buyer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":255,
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OldPromisedShipDate":{
            "type":"string",
            "description":"Date when the supplier initially promised to ship the item to the buyer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedDeliveryDate":{
            "title":"Requested Delivery Date",
            "maxLength":255,
            "type":"string",
            "description":"Date when the buyer requested that the supplier deliver the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedShipDate":{
            "title":"Requested Ship Date",
            "type":"string",
            "description":"Date when the buyer requested that the supplier ship the item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PromisedShipDate":{
            "title":"Promised Ship Date",
            "type":"string",
            "description":"Date when the supplier promises to ship the item to the buyer.",
            "format":"date",
            "nullable":true,
            "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."
        }
    }
}

Back to Top