Create an activity
post
/fscmRestApi/resources/11.13.18.05/publicSectorActivities
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
-
ActivityId: string
Maximum Length:
50
The unique identifier of the activity. -
ActivityName: string
Maximum Length:
250
The activity name. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with this activity. -
Classification: string
Maximum Length:
50
Default Value:PZ
The applicable offering for the activity. -
Description: string
Maximum Length:
1000
The activity description. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity. -
ObjectVersionNumber: integer
(int32)
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.
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.
Root Schema : publicSectorActivities-item-response
Type:
Show Source
object
-
ActivityId: string
Maximum Length:
50
The unique identifier of the activity. -
ActivityName: string
Maximum Length:
250
The activity name. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with this activity. -
Classification: string
Maximum Length:
50
Default Value:PZ
The applicable offering for the activity. -
Description: string
Maximum Length:
1000
The activity description. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
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.
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.