Jump to

• Request
• Response

Update an activity

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivities/{publicSectorActivitiesUniqID}

Request

Path Parameters

• publicSectorActivitiesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ActivityId, AgencyId and Classification ---for the Activities resource and used to uniquely identify an instance of Activities. The client should not generate the hash key value. Instead, the client should query on the Activities collection resource with a filter on the primary key values in order to navigate to a specific instance of Activities.
  
  For example: publicSectorActivities?q=ActivityId=<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

• ActivityName: string
  Maximum Length: 250

  The activity name.
• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The activity description.",
            "nullable":true
        },
        "ActivityName":{
            "maxLength":"250",
            "type":"string",
            "description":"The activity name.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity.",
            "nullable":false
        },
        "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,
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

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

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The activity description.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "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
        },
        "ActivityName":{
            "maxLength":"250",
            "type":"string",
            "description":"The activity name.",
            "nullable":false,
            "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,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ActivityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the activity.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"50",
            "type":"string",
            "description":"The applicable offering for the activity.",
            "nullable":false,
            "default":"PZ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity.",
            "nullable":false,
            "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