Jump to

• Request
• Response

Update a related transaction agency option

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionOptions/{AgencyId}

Request

Path Parameters

• AgencyId(required): integer(int32)
  The unique identifier of the agency.

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

• ApplcntAllApp: string
  Title: Applicants can link transactions to any application

  Maximum Length: 1

  Default Value: N

  Indicates whether an applicant can link all applications as related transaction.
• ApplcntOwnApp: string
  Title: Applicants can link transactions to only their own applications

  Maximum Length: 1

  Default Value: Y

  Indicates whether an applicant can link their own applications as related transaction.
• ContactAllApp: string
  Title: Contact can link transactions to any other application

  Maximum Length: 1

  Default Value: N

  Indicates whether a contact user can link all the applications as related transactions.
• ContactManageApp: string
  Title: Contact can link transactions to any application that they manage

  Maximum Length: 1

  Default Value: N

  Indicates whether a contact user can link only the applications that they manage as related transactions.

{
    "type":"object",
    "properties":{
        "ContactAllApp":{
            "title":"Contact can link transactions to any other application",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a contact user can link all the applications as related transactions.",
            "nullable":false,
            "default":"N"
        },
        "ApplcntOwnApp":{
            "title":"Applicants can link transactions to only their own applications",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an applicant can link their own applications as related transaction.",
            "nullable":false,
            "default":"Y"
        },
        "ContactManageApp":{
            "title":"Contact can link transactions to any application that they manage",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a contact user can link only the applications that they manage as related transactions.",
            "nullable":false,
            "default":"N"
        },
        "ApplcntAllApp":{
            "title":"Applicants can link transactions to any application",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an applicant can link all applications as related transaction.",
            "nullable":false,
            "default":"N"
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency.
• ApplcntAllApp: string
  Title: Applicants can link transactions to any application

  Maximum Length: 1

  Default Value: N

  Indicates whether an applicant can link all applications as related transaction.
• ApplcntOwnApp: string
  Title: Applicants can link transactions to only their own applications

  Maximum Length: 1

  Default Value: Y

  Indicates whether an applicant can link their own applications as related transaction.
• ContactAllApp: string
  Title: Contact can link transactions to any other application

  Maximum Length: 1

  Default Value: N

  Indicates whether a contact user can link all the applications as related transactions.
• ContactManageApp: string
  Title: Contact can link transactions to any application that they manage

  Maximum Length: 1

  Default Value: N

  Indicates whether a contact user can link only the applications that they manage as related transactions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ContactAllApp":{
            "title":"Contact can link transactions to any other application",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a contact user can link all the applications as related transactions.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ApplcntOwnApp":{
            "title":"Applicants can link transactions to only their own applications",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an applicant can link their own applications as related transaction.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ContactManageApp":{
            "title":"Contact can link transactions to any application that they manage",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a contact user can link only the applications that they manage as related transactions.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ApplcntAllApp":{
            "title":"Applicants can link transactions to any application",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an applicant can link all applications as related transaction.",
            "nullable":false,
            "default":"N",
            "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