Jump to

• Request
• Response

Update a data change

patch

/fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges/{LoadChangeId}

Request

Path Parameters

• LoadChangeId(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=
• LoadRowId(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:
  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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• messages: array Data Loader Staging Messages
  Title: Data Loader Staging Messages

  Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.
• UpdatedTextValue: string
  Maximum Length: 4000

  The updated text value of the attribute.

{
    "type":"object",
    "properties":{
        "UpdatedTextValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"The updated text value of the attribute.",
            "nullable":true
        },
        "messages":{
            "title":"Data Loader Staging Messages",
            "type":"array",
            "description":"Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.",
            "items":{
                "$ref":"#/components/schemas/dataLoaderStagingData-dataChanges-messages-item-patch-request"
            }
        }
    }
}

Nested Schema : Data Loader Staging Messages

Type: array

Title: Data Loader Staging Messages

Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.

Show Source

• Array of: object dataLoaderStagingData-dataChanges-messages-item-patch-request

{
    "title":"Data Loader Staging Messages",
    "type":"array",
    "description":"Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.",
    "items":{
        "$ref":"#/components/schemas/dataLoaderStagingData-dataChanges-messages-item-patch-request"
    }
}

Nested Schema : dataLoaderStagingData-dataChanges-messages-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : dataLoaderStagingData-dataChanges-item-response

Type: object

Show Source

• AttributeHierarchy: string
  Title: Attribute Hierarchy

  Read Only: true

  Maximum Length: 1000

  The hierarchy of the attribute.
• DisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 50

  The display name of the attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadChangeId: integer (int64)
  Title: Load Change ID

  Read Only: true

  The unique identifier for the load change.
• LoaderElementAttributeId: integer (int64)
  The unique identifier for the element attribute.
• messages: array Data Loader Staging Messages
  Title: Data Loader Staging Messages

  Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.
• OriginalTextValue: string
  Title: Original Value

  Maximum Length: 4000

  The original text value of the attribute.
• TransformedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the data is transformed, for example, lowercase to uppercase.
• UpdatedTextValue: string
  Maximum Length: 4000

  The updated text value of the attribute.

{
    "type":"object",
    "properties":{
        "LoadChangeId":{
            "title":"Load Change ID",
            "type":"integer",
            "description":"The unique identifier for the load change.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LoaderElementAttributeId":{
            "type":"integer",
            "description":"The unique identifier for the element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginalTextValue":{
            "title":"Original Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The original text value of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TransformedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the data is transformed, for example, lowercase to uppercase.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"50",
            "type":"string",
            "description":"The display name of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedTextValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"The updated text value of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeHierarchy":{
            "title":"Attribute Hierarchy",
            "maxLength":"1000",
            "type":"string",
            "description":"The hierarchy of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "messages":{
            "title":"Data Loader Staging Messages",
            "type":"array",
            "description":"Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.",
            "items":{
                "$ref":"#/components/schemas/dataLoaderStagingData-dataChanges-messages-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Data Loader Staging Messages

Type: array

Title: Data Loader Staging Messages

Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.

Show Source

• Array of: object dataLoaderStagingData-dataChanges-messages-item-response

{
    "title":"Data Loader Staging Messages",
    "type":"array",
    "description":"Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.",
    "items":{
        "$ref":"#/components/schemas/dataLoaderStagingData-dataChanges-messages-item-response"
    }
}

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

Nested Schema : dataLoaderStagingData-dataChanges-messages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadMessageId: integer (int64)
  Title: Load Message ID

  The unique identifier for the load message.
• MessageText: string
  Read Only: true

  The text message.

{
    "type":"object",
    "properties":{
        "LoadMessageId":{
            "title":"Load Message ID",
            "type":"integer",
            "description":"The unique identifier for the load message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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"
            }
        },
        "MessageText":{
            "type":"string",
            "description":"The text message.",
            "nullable":true,
            "readOnly":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"
    }
}

Links

messages

Operation: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingData/{LoadRowId}/child/dataChanges/{LoadChangeId}/child/messages

Parameters:

• LoadChangeId: $request.path.LoadChangeId
• LoadRowId: $request.path.LoadRowId

Use the data loader staging messages resource to retrieve the messages of the particular data loader staging data field.

Back to Top