Jump to

• Request
• Response

Update a tag

patch

/fscmRestApi/resources/11.13.18.05/hedTags/{hedTagsUniqID}

Request

Path Parameters

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

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 : Discriminator: TagTypeCode

Type: object

Discriminator: TagTypeCode

Discriminator Values

• ORA_HEY_SERVICE_HOLD

{
    "discriminator":{
        "propertyName":"TagTypeCode",
        "mapping":{
            "ORA_HEY_SERVICE_HOLD":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

• ORA_HEY_SERVICE_HOLD - object oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-patch-request

{
    "discriminator":{
        "propertyName":"TagTypeCode",
        "mapping":{
            "ORA_HEY_SERVICE_HOLD":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-patch-request

Type: object

Show Source

• associatedTagGroups: array Associated Tag Groups
  Title: Associated Tag Groups

  The associated tag groups resource is used to manage associated tag groups of the tag.
• CommunicationTypeCode: string
  Maximum Length: 30
• DetailedMitigationSteps: string
  Maximum Length: 600
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether a tag is enabled.
• MitigationContactPartyId: integer (int64)
• MitigationDestinationCode: string
  Maximum Length: 30
• MitigationSteps: string
  Maximum Length: 100
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  Alternate identifier for the tag.
• TagDescription: string
  Title: Tag Description

  Maximum Length: 240

  Description for a tag.
• TagName: string
  Title: Tag Name

  Maximum Length: 64

  Name for a tag.

{
    "type":"object",
    "properties":{
        "MitigationSteps":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name for a tag.",
            "nullable":false
        },
        "TagDescription":{
            "title":"Tag Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for a tag.",
            "nullable":true
        },
        "CommunicationTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "MitigationDestinationCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "MitigationContactPartyId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "associatedTagGroups":{
            "title":"Associated Tag Groups",
            "type":"array",
            "description":"The associated tag groups resource is used to manage associated tag groups of the tag.",
            "items":{
                "$ref":"#/components/schemas/hedTags-associatedTagGroups-item-patch-request"
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for the tag.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a tag is enabled.",
            "nullable":false
        },
        "DetailedMitigationSteps":{
            "maxLength":600,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Associated Tag Groups

Type: array

Title: Associated Tag Groups

The associated tag groups resource is used to manage associated tag groups of the tag.

Show Source

• Array of: object hedTags-associatedTagGroups-item-patch-request

{
    "title":"Associated Tag Groups",
    "type":"array",
    "description":"The associated tag groups resource is used to manage associated tag groups of the tag.",
    "items":{
        "$ref":"#/components/schemas/hedTags-associatedTagGroups-item-patch-request"
    }
}

Nested Schema : hedTags-associatedTagGroups-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(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 : Discriminator: TagTypeCode

Type: object

Discriminator: TagTypeCode

Discriminator Values

• ORA_HEY_SERVICE_HOLD

{
    "discriminator":{
        "propertyName":"TagTypeCode",
        "mapping":{
            "ORA_HEY_SERVICE_HOLD":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• ORA_HEY_SERVICE_HOLD - object oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-response

{
    "discriminator":{
        "propertyName":"TagTypeCode",
        "mapping":{
            "ORA_HEY_SERVICE_HOLD":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_hed_campusCommunity_tags_model_view_ServiceHoldTagVO-item-response

Type: object

Show Source

• AssignedFlag: boolean
  Read Only: true

  Indicates whether the tag is assigned to any object.
• CommunicationTypeCode: string
  Maximum Length: 30
• CommunicationTypeMeaning: string
  Read Only: true

  Maximum Length: 80
• DetailedMitigationSteps: string
  Maximum Length: 600
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether a tag is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MitigationContactName: string
  Title: Name

  Read Only: true

  Maximum Length: 360
• MitigationContactPartyId: integer (int64)
• MitigationDestinationCode: string
  Maximum Length: 30
• MitigationDestinationName: string
  Read Only: true

  Maximum Length: 256
• MitigationSteps: string
  Maximum Length: 100
• SeedDataFlag: boolean
  Read Only: true

  Default Value: false

  Indicates whether the record is predefined.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  Alternate identifier for the tag.
• TagDescription: string
  Title: Tag Description

  Maximum Length: 240

  Description for a tag.
• TagGroupCount: integer
  Read Only: true

  Number of associated tag groups.
• TagId: integer (int64)
  Read Only: true

  Unique identifier of the tag.
• TagName: string
  Title: Tag Name

  Maximum Length: 64

  Name for a tag.
• TagTypeCode: string
  Maximum Length: 30

  Default Value: ORA_HEY_SERVICE_HOLD

  Type code for the tag. A list of accepted values is defined in the lookup type ORA_HED_TAG_TYPE_CODE.
• TagTypeMeaning: string
  Title: Tag Type

  Read Only: true

  Maximum Length: 80

  Meaning for the tag type code. A list of accepted values is defined in the lookup type ORA_HED_TAG_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "MitigationDestinationName":{
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TagGroupCount":{
            "type":"integer",
            "description":"Number of associated tag groups.",
            "nullable":true,
            "readOnly":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name for a tag.",
            "nullable":false
        },
        "CommunicationTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "MitigationContactName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TagDescription":{
            "title":"Tag Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for a tag.",
            "nullable":true
        },
        "MitigationDestinationCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "TagTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code for the tag. A list of accepted values is defined in the lookup type ORA_HED_TAG_TYPE_CODE.",
            "nullable":false,
            "default":"ORA_HEY_SERVICE_HOLD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DetailedMitigationSteps":{
            "maxLength":600,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "MitigationSteps":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedFlag":{
            "type":"boolean",
            "description":"Indicates whether the tag is assigned to any object.",
            "nullable":true,
            "readOnly":true
        },
        "TagId":{
            "type":"integer",
            "description":"Unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TagTypeMeaning":{
            "title":"Tag Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning for the tag type code. A list of accepted values is defined in the lookup type ORA_HED_TAG_TYPE_CODE.",
            "nullable":false,
            "readOnly":true
        },
        "SeedDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the record is predefined.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "precision":1
            }
        },
        "CommunicationTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "MitigationContactPartyId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for the tag.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a tag is enabled.",
            "nullable":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."
        }
    }
}

Links

TagTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeTagFinder%3BLookupType%3DORA_HEY_TAG_TYPE_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: TagTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

associatedTagGroups

Operation: /fscmRestApi/resources/11.13.18.05/hedTags/{hedTagsUniqID}/child/associatedTagGroups

Parameters:

• hedTagsUniqID: $request.path.hedTagsUniqID

Back to Top