Jump to

• Request
• Response

Update a target date migration

patch

/hcmRestApi/resources/11.13.18.05/targetDateMigrations/{ConfigId}

Request

Path Parameters

• ConfigId(required): integer(int64)
  Unique identifier for the HNF_CONF_SETUP_B table.

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

• ConfigCode: string
  Maximum Length: 30

  Unique code the configuration setup.
• ConfigId: integer (int64)
  Unique identifier for the HNF_CONF_SETUP_B table.
• ConfigType: string
  Maximum Length: 100

  Configuration type for the setup such as target date and email address.
• ConfigValue: integer (int64)
  Configuration value for the setup. User selects the confguration value. The lookup value is defined in the FND_LOOKUP lookup.
• ModuleId: string
  Maximum Length: 32

  Module is an entry in application taxonomy such as a logical business area. If a value exists in the Module ID column and the owner of the row is not specified, then the seed data framework will not extract the row as seed data.

{
    "type":"object",
    "properties":{
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Module is an entry in application taxonomy such as a logical business area.  If a value exists in the Module ID column and the owner of the row is not specified, then the seed data framework will not extract the row as seed data.",
            "nullable":true
        },
        "ConfigValue":{
            "type":"integer",
            "description":"Configuration value for the setup. User selects the confguration value. The lookup value is defined in the FND_LOOKUP lookup.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ConfigId":{
            "type":"integer",
            "description":"Unique identifier for the HNF_CONF_SETUP_B table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:DOC_SEQUENCE":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ConfigCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code the configuration setup.",
            "nullable":false
        },
        "ConfigType":{
            "maxLength":100,
            "type":"string",
            "description":"Configuration type for the setup such as target date and email address.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : targetDateMigrations-item-response

Type: object

Show Source

• ConfigCode: string
  Maximum Length: 30

  Unique code the configuration setup.
• ConfigId: integer (int64)
  Unique identifier for the HNF_CONF_SETUP_B table.
• ConfigType: string
  Maximum Length: 100

  Configuration type for the setup such as target date and email address.
• ConfigValue: integer (int64)
  Configuration value for the setup. User selects the confguration value. The lookup value is defined in the FND_LOOKUP lookup.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  Module is an entry in application taxonomy such as a logical business area. If a value exists in the Module ID column and the owner of the row is not specified, then the seed data framework will not extract the row as seed data.

{
    "type":"object",
    "properties":{
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Module is an entry in application taxonomy such as a logical business area.  If a value exists in the Module ID column and the owner of the row is not specified, then the seed data framework will not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConfigValue":{
            "type":"integer",
            "description":"Configuration value for the setup. User selects the confguration value. The lookup value is defined in the FND_LOOKUP lookup.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfigId":{
            "type":"integer",
            "description":"Unique identifier for the HNF_CONF_SETUP_B table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:DOC_SEQUENCE":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConfigCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code the configuration setup.",
            "nullable":false,
            "x-queryable":true
        },
        "ConfigType":{
            "maxLength":100,
            "type":"string",
            "description":"Configuration type for the setup such as target date and email address.",
            "nullable":false,
            "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