Jump to

• Request
• Response

Create default property values

post

/fscmRestApi/resources/11.13.18.05/spendClassificationTaxonomies

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• CategoryDescriptionSeperator: string
  Maximum Length: 1

  Symbol used as a separator in the category description.
• CategoryLevels: integer (int32)
  Number of levels in the category hierarchy.
• CategoryNameSeperator: string
  Maximum Length: 30

  Symbol used as a separator in the category name.
• DeleteCategoriesFlag: boolean
  Contains one of the following values: true or false. If true, then all categories should be deleted for a taxonomy. If false, then do not delete all categories for a taxonomy. This attribute does not have a default value.
• Description: string
  Maximum Length: 768

  Description of the taxonomy.
• EntityId: integer (int32)
  Identifies the entity type within the taxonomy.
• OperationName: string
  Maximum Length: 255

  Value that determines the action taken on the taxonomies.
• ProcessId: integer
  Number that uniquely identifies each batch process.
• TargetColumn: string
  Maximum Length: 30

  Target column where the code is populated in the taxonomy.
• TaxonomyCode: string
  Maximum Length: 90

  Abbreviation that identifies the taxonomy.
• TaxonomyFileContent: string
  Content of the file used to upload the categories.
• TaxonomyId: integer (int64)
  Value that uniquely identifies the taxonomy.
• UploadedByCustomer: string
  Maximum Length: 30

  Contains one of the following values: Y, N, or null. If Y, the categories are manually uploaded by the customer; if N or null, the categories are auto-populated using an ESS job. The default value is null.

{
    "type":"object",
    "properties":{
        "CategoryDescriptionSeperator":{
            "maxLength":1,
            "type":"string",
            "description":"Symbol used as a separator in the category description.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryLevels":{
            "type":"integer",
            "description":"Number of levels in the category hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CategoryNameSeperator":{
            "maxLength":30,
            "type":"string",
            "description":"Symbol used as a separator in the category name.",
            "nullable":false,
            "x-queryable":false
        },
        "DeleteCategoriesFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all categories should be deleted for a taxonomy. If false, then do not delete all categories for a taxonomy. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":768,
            "type":"string",
            "description":"Description of the taxonomy.",
            "nullable":false
        },
        "EntityId":{
            "type":"integer",
            "description":"Identifies the entity type within the taxonomy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "OperationName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that determines the action taken on the taxonomies.",
            "nullable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Number that uniquely identifies each batch process.",
            "nullable":true
        },
        "TargetColumn":{
            "maxLength":30,
            "type":"string",
            "description":"Target column where the code is populated in the taxonomy.",
            "nullable":true
        },
        "TaxonomyCode":{
            "maxLength":90,
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "nullable":false
        },
        "TaxonomyFileContent":{
            "type":"string",
            "description":"Content of the file used to upload the categories.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxonomyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the taxonomy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UploadedByCustomer":{
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Y, N, or null. If Y, the categories are manually uploaded by the customer; if N or null, the categories are auto-populated using an ESS job. The default value is null.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• CategoryDescriptionSeperator: string
  Maximum Length: 1

  Symbol used as a separator in the category description.
• CategoryLevels: integer (int32)
  Number of levels in the category hierarchy.
• CategoryNameSeperator: string
  Maximum Length: 30

  Symbol used as a separator in the category name.
• DeleteCategoriesFlag: boolean
  Contains one of the following values: true or false. If true, then all categories should be deleted for a taxonomy. If false, then do not delete all categories for a taxonomy. This attribute does not have a default value.
• Description: string
  Maximum Length: 768

  Description of the taxonomy.
• EntityId: integer (int32)
  Identifies the entity type within the taxonomy.
• LastUpdatedDate: string (date-time)
  Read Only: true

  Date when the taxonomy was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfCategories: integer
  Read Only: true

  Number of categories in the taxonomy.
• OperationName: string
  Maximum Length: 255

  Value that determines the action taken on the taxonomies.
• ProcessId: integer
  Number that uniquely identifies each batch process.
• TargetColumn: string
  Maximum Length: 30

  Target column where the code is populated in the taxonomy.
• TaxonomyCode: string
  Maximum Length: 90

  Abbreviation that identifies the taxonomy.
• TaxonomyFileContent: string
  Content of the file used to upload the categories.
• TaxonomyId: integer (int64)
  Value that uniquely identifies the taxonomy.
• TaxonomyName: string
  Read Only: true

  Maximum Length: 90

  Name of the taxonomy.
• UploadedByCustomer: string
  Maximum Length: 30

  Contains one of the following values: Y, N, or null. If Y, the categories are manually uploaded by the customer; if N or null, the categories are auto-populated using an ESS job. The default value is null.

{
    "type":"object",
    "properties":{
        "CategoryDescriptionSeperator":{
            "maxLength":1,
            "type":"string",
            "description":"Symbol used as a separator in the category description.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryLevels":{
            "type":"integer",
            "description":"Number of levels in the category hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CategoryNameSeperator":{
            "maxLength":30,
            "type":"string",
            "description":"Symbol used as a separator in the category name.",
            "nullable":false,
            "x-queryable":false
        },
        "DeleteCategoriesFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all categories should be deleted for a taxonomy. If false, then do not delete all categories for a taxonomy. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":768,
            "type":"string",
            "description":"Description of the taxonomy.",
            "nullable":false,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Identifies the entity type within the taxonomy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the taxonomy was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfCategories":{
            "type":"integer",
            "description":"Number of categories in the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OperationName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that determines the action taken on the taxonomies.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Number that uniquely identifies each batch process.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetColumn":{
            "maxLength":30,
            "type":"string",
            "description":"Target column where the code is populated in the taxonomy.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxonomyCode":{
            "maxLength":90,
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxonomyFileContent":{
            "type":"string",
            "description":"Content of the file used to upload the categories.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxonomyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the taxonomy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxonomyName":{
            "maxLength":90,
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UploadedByCustomer":{
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Y, N, or null. If Y, the categories are manually uploaded by the customer; if N or null, the categories are auto-populated using an ESS job. The default value is null.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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