Jump to

• Request
• Response

Create ActivityCodes

post

/activityCode

Send a request to this endpoint to create one or more activityCode. An application object will be created for each JSON object provided in the request body.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of activityCode objects.

Root Schema : List<ActivityCode>

Type: array

Title: List<ActivityCode>

Show Source

• Array of: object ActivityCode
  Title: ActivityCode

  ActivityCode Entity

{
    "title":"List<ActivityCode>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ActivityCode"
    }
}

Nested Schema : ActivityCode

Type: object

Title: ActivityCode

ActivityCode Entity

Show Source

• CodeConcatName: string
• CodeTypeName: string
  The name of the parent code type for this code.
• CodeTypeObjectId(required): integer (int32)
  The unique ID of the parent activity code type.
• CodeTypeScope: string
  The scope of the parent activity code type: Global, EPS, or Project. An activity code with Global scope can be assigned to any activity. An activity code with EPS scope can be assigned only to an activity within a project under that particular EPS. Similarly, an activity code with Project scope can be assigned only to an activity within that particular project.
• CodeValue(required): string
  The value of the activity code.
• Color: string
  The Hex representation for the color e.g. 0xFFFFFF.
• CreateDate: string (date-time)
  The date this activity code was created.
• CreateUser: string
  The name of the user that created this activity code.
• Description: string
  The description of the activity code.
• LastUpdateDate: string (date-time)
  The date this activity code was last updated.
• LastUpdateUser: string
  The name of the user that last updated this activity code.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ParentObjectId: integer (int32)
  The unique ID of the parent activity code of this activity code in the hierarchy.
• ProjectObjectId: integer (int32)
  The unique project ID of the parent code type for this code if code type scope is 'Project' or 'EPS', null for code types with scope 'Global'.
• SequenceNumber: integer (int32)
  The sequence number for sorting.

{
    "title":"ActivityCode",
    "required":[
        "CodeTypeObjectId",
        "CodeValue"
    ],
    "type":"object",
    "properties":{
        "CodeConcatName":{
            "type":"string"
        },
        "CodeTypeName":{
            "type":"string",
            "description":"The name of the parent code type for this code."
        },
        "CodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent activity code type.",
            "format":"int32"
        },
        "CodeTypeScope":{
            "type":"string",
            "description":"The scope of the parent activity code type: Global, EPS, or Project. An activity code with Global scope can be assigned to any activity. An activity code with EPS scope can be assigned only to an activity within a project under that particular EPS. Similarly, an activity code with Project scope can be assigned only to an activity within that particular project."
        },
        "CodeValue":{
            "type":"string",
            "description":"The value of the activity code."
        },
        "Color":{
            "type":"string",
            "description":"The Hex representation for the color e.g. 0xFFFFFF."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this activity code was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this activity code."
        },
        "Description":{
            "type":"string",
            "description":"The description of the activity code."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this activity code was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this activity code."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent activity code of this activity code in the hierarchy.",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique project ID of the parent code type for this code if code type scope is 'Project' or 'EPS', null for code types with scope 'Global'.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        }
    },
    "description":"ActivityCode Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Resource Created.

Body ()

Root Schema : String

Type: string

Title: String

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top