Jump to

• Request
• Response

Create a tag group

post

/fscmRestApi/resources/11.13.18.05/hedTagGroups

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• associatedTags: array Associated Tags
  Title: Associated Tags

  The associated tags resource is used to manage associated tags of the tag group.
• EnabledFlag(required): boolean
  Maximum Length: 1

  Indicates whether a tag group is enabled.
• TagGroupCode(required): string
  Title: Tag Group Code

  Maximum Length: 30

  Alternate identifier for a tag group.
• TagGroupDescription: string
  Title: Tag Group Description

  Maximum Length: 240

  Description for a tag group.
• TagGroupName(required): string
  Title: Tag Group Name

  Maximum Length: 64

  Name for a tag group.

{
    "required":[
        "EnabledFlag",
        "TagGroupCode",
        "TagGroupName"
    ],
    "type":"object",
    "properties":{
        "TagGroupName":{
            "title":"Tag Group Name",
            "maxLength":64,
            "type":"string",
            "description":"Name for a tag group.",
            "nullable":false
        },
        "TagGroupDescription":{
            "title":"Tag Group Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for a tag group.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a tag group is enabled.",
            "nullable":false
        },
        "associatedTags":{
            "title":"Associated Tags",
            "type":"array",
            "description":"The associated tags resource is used to manage associated tags of the tag group.",
            "items":{
                "$ref":"#/components/schemas/hedTagGroups-associatedTags-item-post-request"
            }
        },
        "TagGroupCode":{
            "title":"Tag Group Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for a tag group.",
            "nullable":false
        }
    }
}

Nested Schema : Associated Tags

Type: array

Title: Associated Tags

The associated tags resource is used to manage associated tags of the tag group.

Show Source

• Array of: object hedTagGroups-associatedTags-item-post-request

{
    "title":"Associated Tags",
    "type":"array",
    "description":"The associated tags resource is used to manage associated tags of the tag group.",
    "items":{
        "$ref":"#/components/schemas/hedTagGroups-associatedTags-item-post-request"
    }
}

Nested Schema : hedTagGroups-associatedTags-item-post-request

Type: object

Show Source

• TagId: integer (int64)
  Identifier for an associated tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "type":"integer",
            "description":"Identifier for an associated tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

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 : hedTagGroups-item-response

Type: object

Show Source

• associatedTags: array Associated Tags
  Title: Associated Tags

  The associated tags resource is used to manage associated tags of the tag group.
• EnabledFlag: boolean
  Maximum Length: 1

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

  The link relations associated with the resource instance.
• SeedDataFlag: boolean
  Read Only: true

  Default Value: false

  Indicates whether a tag group is predefined.
• TagCount: integer
  Read Only: true

  Number of associated tags.
• TagGroupCode: string
  Title: Tag Group Code

  Maximum Length: 30

  Alternate identifier for a tag group.
• TagGroupDescription: string
  Title: Tag Group Description

  Maximum Length: 240

  Description for a tag group.
• TagGroupId: integer (int64)
  Read Only: true

  Unique identifier of the tag group.
• TagGroupName: string
  Title: Tag Group Name

  Maximum Length: 64

  Name for a tag group.

{
    "type":"object",
    "properties":{
        "TagCount":{
            "type":"integer",
            "description":"Number of associated tags.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TagGroupDescription":{
            "title":"Tag Group Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for a tag group.",
            "nullable":true,
            "x-queryable":true
        },
        "associatedTags":{
            "title":"Associated Tags",
            "type":"array",
            "description":"The associated tags resource is used to manage associated tags of the tag group.",
            "items":{
                "$ref":"#/components/schemas/hedTagGroups-associatedTags-item-response"
            }
        },
        "TagGroupId":{
            "type":"integer",
            "description":"Unique identifier of the tag group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagGroupCode":{
            "title":"Tag Group Code",
            "maxLength":30,
            "type":"string",
            "description":"Alternate identifier for a tag group.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataFlag":{
            "type":"boolean",
            "description":"Indicates whether a tag group is predefined.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "TagGroupName":{
            "title":"Tag Group Name",
            "maxLength":64,
            "type":"string",
            "description":"Name for a tag group.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a tag group is enabled.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Associated Tags

Type: array

Title: Associated Tags

The associated tags resource is used to manage associated tags of the tag group.

Show Source

• Array of: object hedTagGroups-associatedTags-item-response

{
    "title":"Associated Tags",
    "type":"array",
    "description":"The associated tags resource is used to manage associated tags of the tag group.",
    "items":{
        "$ref":"#/components/schemas/hedTagGroups-associatedTags-item-response"
    }
}

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 : hedTagGroups-associatedTags-item-response

Type: object

Show Source

• AssociatedTagId: integer (int64)
  Read Only: true

  Description for an associated tag.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagCode: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the mapping between a tag group and a tag.
• TagDescription: string
  Read Only: true

  Maximum Length: 240

  Code for an associated tag.
• TagId: integer (int64)
  Identifier for an associated tag.
• TagName: string
  Read Only: true

  Maximum Length: 64

  Name for an associated tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "type":"integer",
            "description":"Identifier for an associated tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the mapping between a tag group and a tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagName":{
            "maxLength":64,
            "type":"string",
            "description":"Name for an associated tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Code for an associated tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedTagId":{
            "type":"integer",
            "description":"Description for an associated tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

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

associatedTags

Operation: /fscmRestApi/resources/11.13.18.05/hedTagGroups/{TagGroupId}/child/associatedTags

Parameters:

• TagGroupId: $request.path.TagGroupId

The associated tags resource is used to manage associated tags of the tag group.

Back to Top