Jump to

• Request
• Response

Get one action, not supported

get

/fscmRestApi/resources/11.13.18.05/validateReceivingTransactionDates/{validateReceivingTransactionDatesUniqID}

Request

Path Parameters

• validateReceivingTransactionDatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Validate Receiving Transaction Dates resource and used to uniquely identify an instance of Validate Receiving Transaction Dates. The client should not generate the hash key value. Instead, the client should query on the Validate Receiving Transaction Dates collection resource in order to navigate to a specific instance of Validate Receiving Transaction Dates to get the hash key.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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 : validateReceivingTransactionDates-item-response

Type: object

Show Source

• ErrorCode: string
  Abbreviation that identifies the message that describes the error that occurred when validating the transaction date. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
• ErrorExplanation: string
  Message that describes the error that occurred when validating the transaction date. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
• ItemId: integer
  Value that uniquely identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentTransactionId: integer
  Value that uniquely identifies the parent transaction.
• POLineLocationId: integer
  Value that uniquely identifies the purchase order schedule.
• ReceiptAdviceLineId: integer
  Value that uniquely identifies the RMA receipt advice line.
• ReturnStatus: string
  Status returned by the application when validating the date. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the date for the transaction. ERROR: the validation failed. WARNING: the validation found a potential problem but allowed the transaction to continue.
• ShipmentLineId: integer
  Value that uniquely identifies the shipment line.
• SourceDocumentCode: string
  Document type of the shipment. Valid values are PO, RMA, TRANSFER ORDER and INVENTORY.
• ToOrganizationId: integer
  Value that uniquely identifies the receiving organization.
• TransactionDate: string (date-time)
  Title: Receipt Date

  Date for the current receiving transaction.
• TransactionType: string
  Default Value: RECEIVE

  Type of transaction being validated. Valid values are ACCEPT, REJECT, TRANSFER, DELIVER, CORRECT, RETURN TO VENDOR, RETURN TO RECEIVING, RETURN TO CUSTOMER, and RETURN TO ORGANIZATION.
• TransferOrderLineId: integer
  Value that uniquely identifies the transfer order line.

{
    "type":"object",
    "properties":{
        "TransactionType":{
            "type":"string",
            "description":"Type of transaction being validated. Valid values are ACCEPT, REJECT, TRANSFER, DELIVER, CORRECT, RETURN TO VENDOR, RETURN TO RECEIVING, RETURN TO CUSTOMER, and RETURN TO ORGANIZATION.",
            "nullable":true,
            "default":"RECEIVE",
            "x-queryable":false
        },
        "TransferOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order line.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorExplanation":{
            "type":"string",
            "description":"Message that describes the error that occurred when validating the transaction date. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceiptAdviceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the RMA receipt advice line.",
            "nullable":true,
            "x-queryable":false
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status returned by the application when validating the date. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the date for the transaction. ERROR: the validation failed. WARNING: the validation found a potential problem but allowed the transaction to continue.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the message that describes the error that occurred when validating the transaction date. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentCode":{
            "type":"string",
            "description":"Document type of the shipment. Valid values are PO, RMA, TRANSFER ORDER and INVENTORY.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionDate":{
            "title":"Receipt Date",
            "type":"string",
            "description":"Date for the current receiving transaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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