Jump to

• Request
• Response

Update a project classification

patch

/fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications/{ProjectClassificationId}

Request

Path Parameters

• ProjectClassificationId(required): integer(int64)
  Unique identifier of the project classification.
• projectTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Project Templates resource and used to uniquely identify an instance of Project Templates. The client should not generate the hash key value. Instead, the client should query on the Project Templates collection resource in order to navigate to a specific instance of Project Templates 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 : schema

Type: object

Show Source

• ClassCode: string
  Title: Class Code

  Maximum Length: 240

  Name of the project class code. Enter a value for either this attribute or Class Code ID but not both.
• ClassCodeId: integer (int64)
  Title: Class Code ID

  Unique identifier of the project class code. Enter a value for either this attribute or Class Code but not both.
• CodePercentage: number
  Title: Code Percentage

  Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100.

{
    "type":"object",
    "properties":{
        "ClassCodeId":{
            "title":"Class Code ID",
            "type":"integer",
            "description":"Unique identifier of the project class code. Enter a value for either this attribute or Class Code but not both.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ClassCategoryId"
                ]
            }
        },
        "ClassCode":{
            "title":"Class Code",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project class code. Enter a value for either this attribute or Class Code ID but not both.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CodePercentage":{
            "title":"Code Percentage",
            "type":"number",
            "description":"Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100.",
            "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 : projectTemplates-ProjectClassifications-item-response

Type: object

Show Source

• ClassCategory: string
  Title: Class Category

  Maximum Length: 240

  Name of the project class category. Enter a value for either this attribute or Class Category ID but not both.
• ClassCategoryId: integer (int64)
  Title: Class Category ID

  Unique identifier of the project class category. Enter a value for either this attribute or Class Category but not both.
• ClassCode: string
  Title: Class Code

  Maximum Length: 240

  Name of the project class code. Enter a value for either this attribute or Class Code ID but not both.
• ClassCodeId: integer (int64)
  Title: Class Code ID

  Unique identifier of the project class code. Enter a value for either this attribute or Class Code but not both.
• CodePercentage: number
  Title: Code Percentage

  Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectClassificationId: integer (int64)
  Title: Project Classification ID

  Read Only: true

  Unique identifier of the project classification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCode":{
            "title":"Class Code",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project class code. Enter a value for either this attribute or Class Code ID but not both.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectClassificationId":{
            "title":"Project Classification ID",
            "type":"integer",
            "description":"Unique identifier of the project classification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ClassCategoryId":{
            "title":"Class Category ID",
            "type":"integer",
            "description":"Unique identifier of the project class category. Enter a value for either this attribute or Class Category but not both.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClassCodeId":{
            "title":"Class Code ID",
            "type":"integer",
            "description":"Unique identifier of the project class code. Enter a value for either this attribute or Class Code but not both.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ClassCategoryId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClassCategory":{
            "title":"Class Category",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project class category. Enter a value for either this attribute or Class Category ID but not both.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CodePercentage":{
            "title":"Code Percentage",
            "type":"number",
            "description":"Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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."
        }
    }
}

Back to Top