Jump to

• Request
• Response

Create a set project types

post

/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes

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

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the project type.
• DocGroupId: string
  Title: Group ID

  Maximum Length: 30

  The unique identifier for a document group.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates if the project type is available for the users to select while creating a project.
• LongDescription: string
  Title: Long Description

  Maximum Length: 1000

  The long description of the project type.
• ProjectType: string
  Title: Project Type

  Maximum Length: 50

  The unique name entered by the user to define the project type. Examples of the project type can be Residential and Commercial.
• RuleId: string
  Title: Rule ID

  Maximum Length: 20

  The unique identifier of the auto numbering sequence for the project type.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the project type.",
            "nullable":false
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description of the project type.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ProjectType":{
            "title":"Project Type",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name entered by the user to define the project type. Examples of the project type can be Residential and Commercial.",
            "nullable":false
        },
        "RuleId":{
            "title":"Rule ID",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the auto numbering sequence for the project type.",
            "nullable":false
        },
        "DocGroupId":{
            "title":"Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a document group.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the project type is available for the users to select while creating a project.",
            "nullable":false,
            "default":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 : publicSectorProjectTypes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the project type.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the project type was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the project type.
• DocGroupId: string
  Title: Group ID

  Maximum Length: 30

  The unique identifier for a document group.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates if the project type is available for the users to select while creating a project.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the project type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Title: Long Description

  Maximum Length: 1000

  The long description of the project type.
• ProjectType: string
  Title: Project Type

  Maximum Length: 50

  The unique name entered by the user to define the project type. Examples of the project type can be Residential and Commercial.
• RuleId: string
  Title: Rule ID

  Maximum Length: 20

  The unique identifier of the auto numbering sequence for the project type.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the project type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the project type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the project type.",
            "nullable":false,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description of the project type.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ProjectType":{
            "title":"Project Type",
            "maxLength":"50",
            "type":"string",
            "description":"The unique name entered by the user to define the project type. Examples of the project type can be Residential and Commercial.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule ID",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the auto numbering sequence for the project type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocGroupId":{
            "title":"Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a document group.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the project type is available for the users to select while creating a project.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the project type 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