Jump to

• Request
• Response

Extract an object snapshot

post

/hcmRestApi/objectSnapshots

Retrieves data for a specific key attribute synchronously based on the data structure configured using HCM Extracts.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ExtractsDefinitionName(required): string
  Name of the extract that defines the data elements to be extracted using the REST method.
• parameters(required): array parameters
  Parameters defined in the Extracts and passed as a name-value pair.
• snapshotKey(required): string
  Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts.

{
    "required":[
        "ExtractsDefinitionName",
        "parameters",
        "snapshotKey"
    ],
    "type":"object",
    "properties":{
        "ExtractsDefinitionName":{
            "type":"string",
            "description":"Name of the extract that defines the data elements to be extracted using the REST method."
        },
        "snapshotKey":{
            "type":"string",
            "description":"Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts."
        },
        "parameters":{
            "type":"array",
            "description":"Parameters defined in the Extracts and passed as a name-value pair.",
            "items":{
                "$ref":"#/components/schemas/parameter"
            }
        }
    },
    "example":{
        "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
        "snapshotKey":"300100067510809",
        "parameters":[
            {
                "name":"start_date",
                "value":"2020-10-01"
            },
            {
                "name":"effective_date",
                "value":"2020-10-31"
            }
        ]
    }
}

Example:

{
    "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
    "snapshotKey":"300100067510809",
    "parameters":[
        {
            "name":"start_date",
            "value":"2020-10-01"
        },
        {
            "name":"effective_date",
            "value":"2020-10-31"
        }
    ]
}

Nested Schema : parameters

Type: array

Parameters defined in the Extracts and passed as a name-value pair.

Show Source

• Array of: object parameter

{
    "type":"array",
    "description":"Parameters defined in the Extracts and passed as a name-value pair.",
    "items":{
        "$ref":"#/components/schemas/parameter"
    }
}

Nested Schema : parameter

Type: object

Show Source

• name(required): string
• value(required): string

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : OK

Type: object

Show Source

• ExtractsDefinitionName(required): string
  Name of the extract that defines the data elements to be extracted using the REST method.
• FileContent(required): string
  Base64 encoded XML data extracted for the request payload.
• message(required): string
  Status of the object snapshot request.
• parameters(required): array parameters
  Parameters defined in the Extracts and passed as a name-value pair.
• snapshotKey(required): string
  Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts.
• status(required): string
  Definition of the HTTP response code.

{
    "required":[
        "ExtractsDefinitionName",
        "FileContent",
        "message",
        "parameters",
        "snapshotKey",
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Definition of the HTTP response code."
        },
        "message":{
            "type":"string",
            "description":"Status of the object snapshot request."
        },
        "ExtractsDefinitionName":{
            "type":"string",
            "description":"Name of the extract that defines the data elements to be extracted using the REST method."
        },
        "snapshotKey":{
            "type":"string",
            "description":"Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts."
        },
        "parameters":{
            "type":"array",
            "description":"Parameters defined in the Extracts and passed as a name-value pair.",
            "items":{
                "$ref":"#/components/schemas/parameter"
            }
        },
        "FileContent":{
            "type":"string",
            "description":"Base64 encoded XML data extracted for the request payload."
        }
    },
    "example":{
        "status":"OK",
        "message":"Success",
        "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
        "snapshotKey":"300100067510809",
        "parameters":[
            {
                "name":"start_date",
                "value":"2020-10-01"
            },
            {
                "name":"effective_date",
                "value":"2020-10-31"
            }
        ],
        "FileContent":"PFBFUl9FWFRfU0VDX1BFUlNPTj48UkVQX0NBVEVHT1JZX05BTUU+UEVSX0VYVF9TRUNfUEVSU09OX1Rlc3Q8L1JFUF9DQVRFR09SWV9OQU1FPjxwYXJhbWV0ZXJzPjxyZXF1ZXN0X2lkLz48RkxPV19OQU1FLz48bGVnaXNsYXRpdmVfZGF0YV9ncm91cF9pZC8+PGVmZmVjdGl2ZV9kYXRlPjIwMjAtMTAtMzE8L2VmZmVjdGl2ZV9kYXRlPjxzdGFydF9kYXRlPjIwMjAtMTAtMDE8L3N0YXJ0X2RhdGU+PHJlcG9ydF9jYXRlZ29yeV9pZD4zMDAxMDA1NDY5MzU5NjM8L3JlcG9ydF9jYXRlZ29yeV9pZD48YWN0aW9uX3BhcmFtZXRlcl9ncm91cF9pZC8+PGNoYW5nZXNfb25seS8+PC9wYXJhbWV0ZXJzPjxQZXJzb25fRXh0cmFjdF9EYXRhX0dyb3VwPjxPQkpFQ1RfQUNUSU9OX0lEPjMwMzY1MDU8L09CSkVDVF9BQ1RJT05fSUQ+PFBlcnNvbkRldGFpbHNSZWNvcmQ+PFBlcnNvbklEPjMwMDEwMDA2NzUxMDgwOTwvUGVyc29uSUQ+PFBlcnNvbk51bWJlcj45NTUxNjAwMDgxODMxOTc8L1BlcnNvbk51bWJlcj48UGVyc29uVHlwZUlEPjEzPC9QZXJzb25UeXBlSUQ+PFBlcnNvbk5JRE51bWJlcj43ODktNjctODU2NzwvUGVyc29uTklETnVtYmVyPjwvUGVyc29uRGV0YWlsc1JlY29yZD48L1BlcnNvbl9FeHRyYWN0X0RhdGFfR3JvdXA+PC9QRVJfRVhUX1NFQ19QRVJTT04+Cg=="
    }
}

Example:

{
    "status":"OK",
    "message":"Success",
    "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
    "snapshotKey":"300100067510809",
    "parameters":[
        {
            "name":"start_date",
            "value":"2020-10-01"
        },
        {
            "name":"effective_date",
            "value":"2020-10-31"
        }
    ],
    "FileContent":"PFBFUl9FWFRfU0VDX1BFUlNPTj48UkVQX0NBVEVHT1JZX05BTUU+UEVSX0VYVF9TRUNfUEVSU09OX1Rlc3Q8L1JFUF9DQVRFR09SWV9OQU1FPjxwYXJhbWV0ZXJzPjxyZXF1ZXN0X2lkLz48RkxPV19OQU1FLz48bGVnaXNsYXRpdmVfZGF0YV9ncm91cF9pZC8+PGVmZmVjdGl2ZV9kYXRlPjIwMjAtMTAtMzE8L2VmZmVjdGl2ZV9kYXRlPjxzdGFydF9kYXRlPjIwMjAtMTAtMDE8L3N0YXJ0X2RhdGU+PHJlcG9ydF9jYXRlZ29yeV9pZD4zMDAxMDA1NDY5MzU5NjM8L3JlcG9ydF9jYXRlZ29yeV9pZD48YWN0aW9uX3BhcmFtZXRlcl9ncm91cF9pZC8+PGNoYW5nZXNfb25seS8+PC9wYXJhbWV0ZXJzPjxQZXJzb25fRXh0cmFjdF9EYXRhX0dyb3VwPjxPQkpFQ1RfQUNUSU9OX0lEPjMwMzY1MDU8L09CSkVDVF9BQ1RJT05fSUQ+PFBlcnNvbkRldGFpbHNSZWNvcmQ+PFBlcnNvbklEPjMwMDEwMDA2NzUxMDgwOTwvUGVyc29uSUQ+PFBlcnNvbk51bWJlcj45NTUxNjAwMDgxODMxOTc8L1BlcnNvbk51bWJlcj48UGVyc29uVHlwZUlEPjEzPC9QZXJzb25UeXBlSUQ+PFBlcnNvbk5JRE51bWJlcj43ODktNjctODU2NzwvUGVyc29uTklETnVtYmVyPjwvUGVyc29uRGV0YWlsc1JlY29yZD48L1BlcnNvbl9FeHRyYWN0X0RhdGFfR3JvdXA+PC9QRVJfRVhUX1NFQ19QRVJTT04+Cg=="
}

Nested Schema : parameters

Type: array

Parameters defined in the Extracts and passed as a name-value pair.

Show Source

• Array of: object parameter

{
    "type":"array",
    "description":"Parameters defined in the Extracts and passed as a name-value pair.",
    "items":{
        "$ref":"#/components/schemas/parameter"
    }
}

Nested Schema : parameter

Type: object

Show Source

• name(required): string
• value(required): string

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

400 Response

Body ()

Root Schema : BAD_REQUEST

Type: object

Show Source

• ExtractsDefinitionName(required): string
  Name of the extract that defines the data elements to be extracted using the REST method.
• message(required): string
  Status of the object snapshot request.
• parameters(required): array parameters
  Parameters defined in the Extracts and passed as a name-value pair.
• snapshotKey(required): string
  Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts.
• status(required): string
  Definition of the HTTP response code.

{
    "required":[
        "ExtractsDefinitionName",
        "message",
        "parameters",
        "snapshotKey",
        "status",
        "FileContent"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Definition of the HTTP response code."
        },
        "message":{
            "type":"string",
            "description":"Status of the object snapshot request."
        },
        "ExtractsDefinitionName":{
            "type":"string",
            "description":"Name of the extract that defines the data elements to be extracted using the REST method."
        },
        "snapshotKey":{
            "type":"string",
            "description":"Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts."
        },
        "parameters":{
            "type":"array",
            "description":"Parameters defined in the Extracts and passed as a name-value pair.",
            "items":{
                "$ref":"#/components/schemas/parameter"
            }
        }
    },
    "example":{
        "status":"BAD_REQUEST",
        "message":"You need to enable the Extracts for object snapshot support.",
        "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
        "snapshotKey":"300100067510809",
        "parameters":[
            {
                "name":"start_date",
                "value":"2020-10-01"
            },
            {
                "name":"effective_date",
                "value":"2020-10-31"
            }
        ]
    }
}

Example:

{
    "status":"BAD_REQUEST",
    "message":"You need to enable the Extracts for object snapshot support.",
    "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
    "snapshotKey":"300100067510809",
    "parameters":[
        {
            "name":"start_date",
            "value":"2020-10-01"
        },
        {
            "name":"effective_date",
            "value":"2020-10-31"
        }
    ]
}

Nested Schema : parameters

Type: array

Parameters defined in the Extracts and passed as a name-value pair.

Show Source

• Array of: object parameter

{
    "type":"array",
    "description":"Parameters defined in the Extracts and passed as a name-value pair.",
    "items":{
        "$ref":"#/components/schemas/parameter"
    }
}

Nested Schema : parameter

Type: object

Show Source

• name(required): string
• value(required): string

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

500 Response

Body ()

Root Schema : INTERNAL_SERVER_ERROR

Type: object

Show Source

• ExtractsDefinitionName: string
  Name of the extract that defines the data elements to be extracted using the REST method.
• message(required): string
  Status of the object snapshot request.
• parameters: array parameters
  Parameters defined in the Extracts and passed as a name-value pair.
• snapshotKey: string
  Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts.
• status(required): string
  Definition of the HTTP response code.

{
    "required":[
        "message",
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Definition of the HTTP response code."
        },
        "message":{
            "type":"string",
            "description":"Status of the object snapshot request."
        },
        "ExtractsDefinitionName":{
            "type":"string",
            "description":"Name of the extract that defines the data elements to be extracted using the REST method."
        },
        "snapshotKey":{
            "type":"string",
            "description":"Parameter configured in the Extracts definition, which is also the threading database item defined in the Extracts."
        },
        "parameters":{
            "type":"array",
            "description":"Parameters defined in the Extracts and passed as a name-value pair.",
            "items":{
                "$ref":"#/components/schemas/parameter"
            }
        }
    },
    "example":{
        "status":"INTERNAL_SERVER_ERROR",
        "message":"Error while fetching details",
        "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
        "snapshotKey":"300100067510809",
        "parameters":[
            {
                "name":"start_date",
                "value":"2020-10-01"
            },
            {
                "name":"effective_date",
                "value":"2020-10-31"
            }
        ]
    }
}

Example:

{
    "status":"INTERNAL_SERVER_ERROR",
    "message":"Error while fetching details",
    "ExtractsDefinitionName":"PER_EXT_SEC_PERSON_Test",
    "snapshotKey":"300100067510809",
    "parameters":[
        {
            "name":"start_date",
            "value":"2020-10-01"
        },
        {
            "name":"effective_date",
            "value":"2020-10-31"
        }
    ]
}

Nested Schema : parameters

Type: array

Parameters defined in the Extracts and passed as a name-value pair.

Show Source

• Array of: object parameter

{
    "type":"array",
    "description":"Parameters defined in the Extracts and passed as a name-value pair.",
    "items":{
        "$ref":"#/components/schemas/parameter"
    }
}

Nested Schema : parameter

Type: object

Show Source

• name(required): string
• value(required): string

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top