Create an activity status
post
/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses
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
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorActivityStatuses-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.