Jump to

• Request
• Response

Update an activity status

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses/{publicSectorActivityStatusesUniqID}

Request

Path Parameters

• publicSectorActivityStatusesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ActivityStatus, AgencyId and Classification ---for the Activity Statuses resource and used to uniquely identify an instance of Activity Statuses. The client should not generate the hash key value. Instead, the client should query on the Activity Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Statuses.
  
  For example: publicSectorActivityStatuses?q=ActivityStatus=<value1>;AgencyId=<value2>;Classification=<value3>

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

• DeletedFlag: string
  Title: Deleted

  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the activity status.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.
• ModuleId: string
  Maximum Length: 32

  The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
• SeedDataSource: string
  Maximum Length: 512

  The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.
• SystemStatus: string
  Title: System Status

  Maximum Length: 15

  The system status.
• SystemUse: boolean
  Title: System Use

  Maximum Length: 1

  The system use.

{
    "type":"object",
    "properties":{
        "SystemStatus":{
            "title":"System Status",
            "maxLength":"15",
            "type":"string",
            "description":"The system status.",
            "nullable":false
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the activity status.",
            "nullable":false
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "SystemUse":{
            "title":"System Use",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system use.",
            "nullable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.",
            "nullable":false,
            "default":"N"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• ActivityStatus: string
  Title: Activity Status

  Maximum Length: 15

  The status of the activity.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with this activity.
• Classification: string
  Title: Classification

  Maximum Length: 3

  Default Value: PZ

  The classification type for the record status.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the activity status was created.
• DeletedFlag: string
  Title: Deleted

  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the activity status.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the status was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
• SeedDataSource: string
  Maximum Length: 512

  The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.
• SystemStatus: string
  Title: System Status

  Maximum Length: 15

  The system status.
• SystemUse: boolean
  Title: System Use

  Maximum Length: 1

  The system use.

{
    "type":"object",
    "properties":{
        "SystemStatus":{
            "title":"System Status",
            "maxLength":"15",
            "type":"string",
            "description":"The system status.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the activity status was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "title":"Activity Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the activity.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the activity status.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with this activity.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "SystemUse":{
            "title":"System Use",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system use.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The classification type for the record status.",
            "nullable":false,
            "default":"PZ",
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the status 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