Jump to

• Request
• Response

Get a data set message

get

/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/messages/{MessageLineId}

Request

Path Parameters

• MessageLineId(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=
• RequestId(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=

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 : dataLoadDataSets-messages-item-response

Type: object

Show Source

• BusinessObjectDiscriminator: string
  Read Only: true

  Maximum Length: 100

  Discriminator of the business object in the message.
• ConcatenatedUserKey: string
  Read Only: true

  Maximum Length: 240

  Concatenated user key values that identify the record.
• DataSetBusObjId: integer (int64)
  Read Only: true

  Surrogate identifier of the business object.
• DataSetId: integer (int64)
  Read Only: true

  System-generated unique identifier of the data set.
• DatFileName: string
  Read Only: true

  Maximum Length: 200

  Name of the business object file.
• EffectiveEndDate: string (date-time)
  Read Only: true

  Effective end date of the record associated with the message.
• EffectiveLatestChange: string
  Read Only: true

  Maximum Length: 4

  Effective latest change flag for the record associated with the message.
• EffectiveSequence: integer
  Read Only: true

  Effective sequence number of the record associated with the message.
• EffectiveStartDate: string (date-time)
  Read Only: true

  Effective start date of the record associated with the message.
• FileLine: integer
  Read Only: true

  File line number in the data file associated with the message.
• FusionGUID: string
  Read Only: true

  Maximum Length: 255

  Globally unique identifier of the record associated with the message.
• GeneratedByCode: string
  Read Only: true

  Maximum Length: 120

  Code for the generating source of the message.
• GeneratedByMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the generating source of the message.
• LineOperation: string
  Read Only: true

  Maximum Length: 80

  Operation supplied for the file line associated with the message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageLineId: integer (int64)
  Read Only: true

  System-generated identifier for the message.
• MessageText: string
  Read Only: true

  Maximum Length: 500

  Error or warning message text.
• MessageTypeCode: string
  Read Only: true

  Maximum Length: 20

  Code for the message type.
• MessageTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Description of the message type.
• MessageUserDetails: string
  Read Only: true

  Maximum Length: 4000

  User details of the message.
• OriginatingProcessCode: string
  Read Only: true

  Maximum Length: 30

  Code for the originating process of the message.
• OriginatingProcessName: string
  Read Only: true

  Maximum Length: 80

  Name of the originating process of the message.
• ReportedAgainstCode: string
  Read Only: true

  Maximum Length: 30

  Code for the type of record associated with the message.
• ReportedAgainstMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the type of record associated with the message.
• SourceReference001: string
  Read Only: true

  Maximum Length: 800

  First source reference value of the record associated with the message.
• SourceReference002: string
  Read Only: true

  Maximum Length: 800

  Second source reference value of the record associated with the message.
• SourceReference003: string
  Read Only: true

  Maximum Length: 800

  Third source reference value of the record associated with the message.
• SourceReference004: string
  Read Only: true

  Maximum Length: 800

  Fourth source reference value of the record associated with the message.
• SourceReference005: string
  Read Only: true

  Maximum Length: 800

  Fifth source reference value of the record associated with the message.
• SourceReference006: string
  Read Only: true

  Maximum Length: 800

  Sixth source reference value of the record associated with the message.
• SourceReference007: string
  Read Only: true

  Maximum Length: 800

  Seventh source reference value of the record associated with the message.
• SourceReference008: string
  Read Only: true

  Maximum Length: 800

  Eighth source reference value of the record associated with the message.
• SourceReference009: string
  Read Only: true

  Maximum Length: 800

  Ninth source reference value of the record associated with the message.
• SourceReference010: string
  Read Only: true

  Maximum Length: 800

  Tenth source reference value of the record associated with the message.
• SourceReferenceName001: string
  Read Only: true

  Maximum Length: 800

  First source reference name of the record associated with the message.
• SourceReferenceName002: string
  Read Only: true

  Maximum Length: 800

  Second source reference name of the record associated with the message.
• SourceReferenceName003: string
  Read Only: true

  Maximum Length: 800

  Third source reference name of the record associated with the message.
• SourceReferenceName004: string
  Read Only: true

  Maximum Length: 800

  Fourth source reference name of the record associated with the message.
• SourceReferenceName005: string
  Read Only: true

  Maximum Length: 800

  Fifth source reference name of the record associated with the message.
• SourceReferenceName006: string
  Read Only: true

  Maximum Length: 800

  Sixth source reference name of the record associated with the message.
• SourceReferenceName007: string
  Read Only: true

  Maximum Length: 800

  Seventh source reference name of the record associated with the message.
• SourceReferenceName008: string
  Read Only: true

  Maximum Length: 800

  Eighth source reference name of the record associated with the message.
• SourceReferenceName009: string
  Read Only: true

  Maximum Length: 800

  Ninth source reference name of the record associated with the message.
• SourceReferenceName010: string
  Read Only: true

  Maximum Length: 800

  Tenth source reference name of the record associated with the message.
• SourceSystemId: string
  Read Only: true

  Maximum Length: 2000

  Source system identifier used to uniquely identify the record associated with the message.
• SourceSystemOwner: string
  Read Only: true

  Maximum Length: 256

  Source system owner used to uniquely identify the record associated with the message.
• SurrogateId: integer
  Read Only: true

  Surrogate identifier of the record the message associated with the message.

{
    "type":"object",
    "properties":{
        "SourceReferenceName005":{
            "maxLength":"800",
            "type":"string",
            "description":"Fifth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName006":{
            "maxLength":"800",
            "type":"string",
            "description":"Sixth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference001":{
            "maxLength":"800",
            "type":"string",
            "description":"First source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReferenceName003":{
            "maxLength":"800",
            "type":"string",
            "description":"Third source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference002":{
            "maxLength":"800",
            "type":"string",
            "description":"Second source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveLatestChange":{
            "maxLength":"4",
            "type":"string",
            "description":"Effective latest change flag for the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName004":{
            "maxLength":"800",
            "type":"string",
            "description":"Fourth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference003":{
            "maxLength":"800",
            "type":"string",
            "description":"Third source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReferenceName009":{
            "maxLength":"800",
            "type":"string",
            "description":"Ninth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference004":{
            "maxLength":"800",
            "type":"string",
            "description":"Fourth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReference005":{
            "maxLength":"800",
            "type":"string",
            "description":"Fifth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName007":{
            "maxLength":"800",
            "type":"string",
            "description":"Seventh source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference006":{
            "maxLength":"800",
            "type":"string",
            "description":"Sixth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetBusObjId":{
            "type":"integer",
            "description":"Surrogate identifier of the business object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceReferenceName008":{
            "maxLength":"800",
            "type":"string",
            "description":"Eighth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference007":{
            "maxLength":"800",
            "type":"string",
            "description":"Seventh source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MessageUserDetails":{
            "maxLength":"4000",
            "type":"string",
            "description":"User details of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference008":{
            "maxLength":"800",
            "type":"string",
            "description":"Eighth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference009":{
            "maxLength":"800",
            "type":"string",
            "description":"Ninth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReportedAgainstCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the type of record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceSystemId":{
            "maxLength":"2000",
            "type":"string",
            "description":"Source system identifier used to uniquely identify the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReferenceName001":{
            "maxLength":"800",
            "type":"string",
            "description":"First source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName002":{
            "maxLength":"800",
            "type":"string",
            "description":"Second source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileLine":{
            "type":"integer",
            "description":"File line number in the data file associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MessageTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Code for the message type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveSequence":{
            "type":"integer",
            "description":"Effective sequence number of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OriginatingProcessName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the originating process of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConcatenatedUserKey":{
            "maxLength":"240",
            "type":"string",
            "description":"Concatenated user key values that identify the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "BusinessObjectDiscriminator":{
            "maxLength":"100",
            "type":"string",
            "description":"Discriminator of the business object in the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReference010":{
            "maxLength":"800",
            "type":"string",
            "description":"Tenth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceSystemOwner":{
            "maxLength":"256",
            "type":"string",
            "description":"Source system owner used to uniquely identify the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReportedAgainstMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the type of record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the record associated with the message.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FusionGUID":{
            "maxLength":"255",
            "type":"string",
            "description":"Globally unique identifier of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeneratedByCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Code for the generating source of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SurrogateId":{
            "type":"integer",
            "description":"Surrogate identifier of the record the message associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataSetId":{
            "type":"integer",
            "description":"System-generated unique identifier of the data set.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "DatFileName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the business object file.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":"500",
            "type":"string",
            "description":"Error or warning message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName010":{
            "maxLength":"800",
            "type":"string",
            "description":"Tenth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OriginatingProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the originating process of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeneratedByMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the generating source of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageLineId":{
            "type":"integer",
            "description":"System-generated identifier for the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the message type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineOperation":{
            "maxLength":"80",
            "type":"string",
            "description":"Operation supplied for the file line associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the record associated with the message.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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